Cell_CellSelection

Defined in: features/cell-selection/cellSelectionFeature.types.ts:158

Properties

getCanSelect

getCanSelect: () => boolean;

Defined in: features/cell-selection/cellSelectionFeature.types.ts:162

Checks whether this cell can currently be selected.

Returns

boolean

getIsFocused

getIsFocused: () => boolean;

Defined in: features/cell-selection/cellSelectionFeature.types.ts:167

Checks whether this cell is the active cell, i.e. the anchor of the most recent range.

Returns

boolean

getIsSelected

getIsSelected: () => boolean;

Defined in: features/cell-selection/cellSelectionFeature.types.ts:171

Checks whether this cell falls inside the final positive selection.

Returns

boolean

getSelectionEdges

getSelectionEdges: () => CellSelectionEdges;

Defined in: features/cell-selection/cellSelectionFeature.types.ts:179

Returns which sides of this cell sit on the outer boundary of the selection, for rendering a spreadsheet-style outline without each cell inspecting its neighbours.

All sides are false when the cell is not selected.

Returns

CellSelectionEdges

getSelectionExtendHandler

getSelectionExtendHandler: () => (event) => void;

Defined in: features/cell-selection/cellSelectionFeature.types.ts:187

Creates a handler that extends the active range to this cell while a drag is in progress. Bind it to mouseenter.

The handler no-ops unless a drag is open, and skips redundant writes when the active range already focuses this cell.

Returns

(event) => void

getSelectionStartHandler

getSelectionStartHandler: (contextDocument?) => (event) => void;

Defined in: features/cell-selection/cellSelectionFeature.types.ts:198

Creates a handler that begins a selection at this cell. Bind it to mousedown.

Pass the original mouse event, or a framework event whose nativeEvent is that event, so modifier keys can be detected. The handler attaches its own document-level mouseup listener so a drag released outside the table still ends correctly; pass contextDocument when the table renders into another document, such as an iframe or popout window.

Parameters

contextDocument?

Document

Returns

(event) => void

getTabIndex

getTabIndex: () => number;

Defined in: features/cell-selection/cellSelectionFeature.types.ts:204

Returns 0 for the focused cell and -1 otherwise, for roving tabindex.

Returns

number