GridRowId

Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

export type GridRowId = string | number;

APIs using this type

• getRowId

  Returns a stable, unique row ID. The same business row must retain its ID after sorting, filtering, and editing.

• getRow

  Finds a row object by stable row ID, rather than display index.

• stageBatchCell

  Stages a batch value by row and column ID. Does not immediately persist final data.

• startRowEdit

  Starts full-row editing for a row ID.

• getCellRendererInstance

  Queries mounted cell renderer instances. Offscreen cells may be unmounted because of virtualization.

• destroyCellRendererInstance

  Destroys a specified mounted cell renderer instance.

• focusCellRendererInstance

  Moves focus into a mounted cell renderer and returns the result.

Contracts containing this type

• GridGetRowId
• GridLiveObjectEvent
• GridLiveRef
• GridRowRef
• SyGridBatchCommitReport
• SyGridCellValueChangedEventDetail
• SyGridEditRejectedCell
• SyGridEventMap
• SyGridFillRangeReport
• SyGridFullWidthLayoutReport
• SyGridFullWidthRenderParams
• SyGridFullWidthRowInfo
• SyGridImperativeMethods
• SyGridPendingBatchCell
• SyGridPinnedRow
• SyGridPinnedRowChange
• SyGridPinnedRowInput
• SyGridPinnedRowRejection
• SyGridPinnedRowsChangedDetail
• SyGridPinnedRowsReport
• SyGridPinnedRowsResult
• SyGridRowDragStartInput
• SyGridRowEditReport
• SyGridRowEditStartEventDetail
• SyGridRowEditStopEventDetail
• SyGridRowValueChangedEventDetail
• SyGridSelectionChangedEventDetail