CellDeselectEvent

Event arguments for cell deselection events. Provides context about cells being removed from the selection.

Props

The following table outlines the props for the CellDeselectEvent:

NameTypeDefaultDescription
cells
[ ]

Array of cell positions being deselected in data-based format. Uses primary key and field name for persistent identification.

data
[ ]

Array of cell data values for cells being deselected.

deselectedRowCells
undefined

Array of deselected 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.

event
MouseEvent | KeyboardEvent
-

The browser event that triggered the deselection.