Interface: Table_RowSelection<TFeatures, TData>

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getFilteredSelectedRowModel()

getFilteredSelectedRowModel: () => RowModel<TFeatures, TData>;

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

Returns the row model of all rows that are selected after filtering has been applied.

Returns

RowModel<TFeatures, TData>

getGroupedSelectedRowModel()

getGroupedSelectedRowModel: () => RowModel<TFeatures, TData>;

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

Returns the row model of all rows that are selected after grouping has been applied.

Returns

RowModel<TFeatures, TData>

getIsAllPageRowsSelected()

getIsAllPageRowsSelected: () => boolean;

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

Returns whether or not all rows on the current page are selected.

Returns

boolean

getIsAllRowsSelected()

getIsAllRowsSelected: () => boolean;

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

Returns whether or not all rows in the table are selected.

Returns

boolean

getIsSomePageRowsSelected()

getIsSomePageRowsSelected: () => boolean;

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

Returns whether or not any rows on the current page are selected.

Returns

boolean

getIsSomeRowsSelected()

getIsSomeRowsSelected: () => boolean;

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

Returns whether or not any rows in the table are selected.

Returns

boolean

getPreSelectedRowModel()

getPreSelectedRowModel: () => RowModel<TFeatures, TData>;

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

Returns the core row model of all rows before row selection has been applied.

Returns

RowModel<TFeatures, TData>

getSelectedRowModel()

getSelectedRowModel: () => RowModel<TFeatures, TData>;

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

Returns the row model of all rows that are selected.

Returns

RowModel<TFeatures, TData>

getToggleAllPageRowsSelectedHandler()

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

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

Returns a handler that can be used to toggle all rows on the current page.

Returns

(event): void;

Parameters

event

unknown

Returns

void

getToggleAllRowsSelectedHandler()

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

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

Returns a handler that can be used to toggle all rows in the table.

Returns

(event): void;

Parameters

event

unknown

Returns

void

resetRowSelection()

resetRowSelection: (defaultState?) => void;

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

Resets the rowSelection state to the initialState.rowSelection, or true can be passed to force a default blank state reset to {}.

Parameters

defaultState?

boolean

Returns

void

setRowSelection()

setRowSelection: (updater) => void;

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

Sets or updates the state.rowSelection state.

Parameters

updater

Updater<RowSelectionState>

Returns

void

toggleAllPageRowsSelected()

toggleAllPageRowsSelected: (value?) => void;

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

Selects/deselects all rows on the current page.

Parameters

value?

boolean

Returns

void

toggleAllRowsSelected()

toggleAllRowsSelected: (value?) => void;

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

Selects/deselects all rows in the table.

Parameters

value?

boolean

Returns

void