Row_RowSelection

Defined in: features/row-selection/rowSelectionFeature.types.ts:89

Properties#

getCanMultiSelect#

getCanMultiSelect: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:93

Checks whether this row can be selected alongside other rows.

Returns#

boolean

getCanSelect#

getCanSelect: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:97

Checks whether this row can currently be selected.

Returns#

boolean

getCanSelectSubRows#

getCanSelectSubRows: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:101

Checks whether selecting this row should also select its subRows.

Returns#

boolean

getIsAllSubRowsSelected#

getIsAllSubRowsSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:105

Checks whether all selectable descendants are selected.

Returns#

boolean

getIsSelected#

getIsSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:109

Checks whether this row id is selected.

Returns#

boolean

getIsSomeSelected#

getIsSomeSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:113

Checks whether some selectable descendants are selected.

Returns#

boolean

getToggleSelectedHandler#

getToggleSelectedHandler: (opts?) => (event) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:120

Creates a checkbox-style handler that toggles this row's selected state. Pass the original checkbox click event, or a framework event whose nativeEvent is that click, so Shift range selection can detect the modifier key.

Parameters#

opts?#

ToggleSelectedOptions

Returns#

(event) => void

toggleSelected#

toggleSelected: (value?, opts?) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:126

Selects/deselects the row.

Parameters#

value?#

boolean

opts?#

ToggleSelectedOptions

Returns#

void