CellSelectEvent

Event arguments for cell selection events in the Data Grid component. Provides detailed context about selected cells, ranges, data, and user interaction. Used for handling post-selection logic or UI updates.

Props

The following table outlines the props for the CellSelectEvent:

NameTypeDefaultDescription
activeCell
CellIdentifier | null
null

The currently active (focused) cell position in data-based format. Represents the cell that has keyboard focus using primary key and field name. Persists across paging, sorting, and filtering operations.

cells
CellIdentifier[]
[ ]

Array of selected cell positions in data-based format (rowKey and fieldName). Provides persistent identification of cells across paging, sorting, and filtering. Each position contains the primary key value and field name of a selected cell.

data
CellData<T>[]
[ ]

Array of cell data values for all selected cells. Contains the actual data from each selected cell.

event
MouseEvent | KeyboardEvent
-

The browser event that triggered the cell selection. Can be a mouse event (click, drag) or keyboard event (Shift+Arrow).

range
CellRange
undefined

The cell range if range selection was performed. Present only when user selects multiple cells via drag or Shift+Click.

selectedRowCells
RowCellInfo[]
undefined

Array of selected cells grouped by row in the format appropriate for the current selection mode. In index-based mode: contains { rowIndex, cellIndexes } format. In data-based mode: contains { rowKey, fieldNames } format. Populated when cellPersistSelection is enabled or when working with persistent key values.