RowSelectionApi<T>

Methods for managing row selection in Graphite Grid.

Type parameters

Type parameter
`T`

Properties

Name
deselectAllRows
Type
() => void
Description
Deselects all rows in the grid.
Name
getRowSelectionDeselectEnabled
Type
() => boolean
Description
Checks if row deselection is enabled.
Name
getRowSelectionMode
Type
() => RowSelectionMode
Description
Gets the current row selection mode.
Name
getRowSelectionMouseActivator
Type
() => RowSelectionPointerActivator
Description
Gets the current pointer interaction that triggers row selection.
Name
getRowSelectionPivotBehavior
Type
() => RowSelectionPivotBehavior
Description
Gets the current row selection pivot behavior.
Name
getSelectedRows
Type
() => Set<string>
Description
Gets the currently selected rows in the grid.
Name
isRowSelectAllSupported
Type
() => boolean
Description
Checks if selecting all rows is supported by the data source.
Name
isRowSelectable
Type
(rowOrId: string | RowNode<T>) => boolean
Description
Checks if a specific row is selectable.
Name
isRowSelected
Type
(row: string | RowNode<T>) => boolean
Description
Checks if a specific row is selected.
Name
selectAllRowsExn
Type
() => void
Description
Selects all rows in the grid. Throws an error if not supported by the data source.
Name
setRowSelectionDeselectEnabled
Type
(enabled: boolean) => void
Description
Enables or disables row deselection.
Name
setRowSelectionMode
Type
(mode: RowSelectionMode) => void
Description
Sets the row selection mode.
Name
setRowSelectionMouseActivator
Type
(activator: RowSelectionPointerActivator) => void
Description
Sets the pointer interaction that triggers row selection.
Name
setRowSelectionPivotBehavior
Type
(behavior: RowSelectionPivotBehavior) => void
Description
Sets the row selection pivot behavior.
Name
setSelectedRows
Type
(s: Set<string>) => void
Description
Sets the rows to be selected in the grid.
Name
toggleRowSelection
Type
(row: string | RowNode<T>) => void
Description
Toggles the selection state of a specific row.