Table_RowExpanding

Defined in: features/row-expanding/rowExpandingFeature.types.ts:72

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

_expandRows#

_expandRows: (rowModel) => RowModel<TFeatures, TData>;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:82

Internal

Lists expanded sub-rows inline below their parents. Row display order and the paginated row model expand rows through it.

Parameters#

rowModel#

RowModel<TFeatures, TData>

Returns#

RowModel<TFeatures, TData>

autoResetExpanded#

autoResetExpanded: () => void;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:91

Resets expanded state after the table data or grouping changes.

Honors autoResetAll, autoResetExpanded, and manualExpanding. Called by the row models; you rarely need to invoke it yourself.

Returns#

void

getCanSomeRowsExpand#

getCanSomeRowsExpand: () => boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:95

Checks whether at least one row can be expanded.

Returns#

boolean

getExpandedDepth#

getExpandedDepth: () => number;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:99

Computes the deepest expanded row id depth.

Returns#

number

getIsAllRowsExpanded#

getIsAllRowsExpanded: () => boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:103

Checks whether all rows in the current row model are expanded.

Returns#

boolean

getIsSomeRowsExpanded#

getIsSomeRowsExpanded: () => boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:107

Checks whether any row is currently expanded.

Returns#

boolean

getToggleAllRowsExpandedHandler#

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

Defined in: features/row-expanding/rowExpandingFeature.types.ts:111

Creates a handler that toggles all rows expanded.

Returns#

(event) => void

resetExpanded#

resetExpanded: (defaultState?) => void;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:117

Resets expanded to initialState.expanded.

Pass true to ignore initial state and reset to {}.

Parameters#

defaultState?#

boolean

Returns#

void

setExpanded#

setExpanded: (updater) => void;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:121

Updates expanded state with true, a row-id map, or an updater function.

Parameters#

updater#

Updater<ExpandedState>

Returns#

void

toggleAllRowsExpanded#

toggleAllRowsExpanded: (expanded?) => void;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:125

Toggles the expanded state for all rows.

Parameters#

expanded?#

boolean

Returns#

void