Grid API
CellSelectionApi
Contains methods for managing cell selection within Graphite Grid.
Properties
- Name
getCellFieldValueExn- Type
- (rowIndex: number, columnIndex: number) => unknown
- Description
Retrieves the field value for the cell at specified row and column indices. Throws an error if the indices are out of bounds.
- Name
getCellSelection- Type
- () => null | SelectionRect
- Description
Retrieves the current cell selection, or null if no selection is active.
- Name
getCellSelectionMode- Type
- () => CellSelectionMode
- Description
Retrieves the current cell selection mode.
- Name
isCellSelected- Type
- (rowIndex: number, columnIndex: number) => boolean
- Description
Checks if the cell at specified row and column indices is selected.
- Name
setCellSelection- Type
- (p: null | SelectionRect, withPivot?: boolean) => void
- Description
Sets the current cell selection, ignoring the current CellSelectionMode.
- Name
setCellSelectionMode- Type
- (p: CellSelectionMode) => void
- Description
Sets the cell selection mode.