Table_RowPinning

Defined in: features/row-pinning/rowPinningFeature.types.ts:65

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getBottomRows

getBottomRows: () => Row<TFeatures, TData>[];

Defined in: features/row-pinning/rowPinningFeature.types.ts:72

Gets rows pinned to the bottom region.

Returns

Row<TFeatures, TData>[]

getCenterRows

getCenterRows: () => Row<TFeatures, TData>[];

Defined in: features/row-pinning/rowPinningFeature.types.ts:76

Gets rows that are not pinned to the top or bottom region.

Returns

Row<TFeatures, TData>[]

getIsSomeRowsPinned

getIsSomeRowsPinned: (position?) => boolean;

Defined in: features/row-pinning/rowPinningFeature.types.ts:80

Checks whether any rows are pinned, optionally limited to one region.

Parameters

position?

RowPinningPosition

Returns

boolean

getTopRows

getTopRows: () => Row<TFeatures, TData>[];

Defined in: features/row-pinning/rowPinningFeature.types.ts:84

Gets rows pinned to the top region.

Returns

Row<TFeatures, TData>[]

resetRowPinning

resetRowPinning: (defaultState?) => void;

Defined in: features/row-pinning/rowPinningFeature.types.ts:90

Resets rowPinning to initialState.rowPinning.

Pass true to ignore initial state and reset to empty top/bottom arrays.

Parameters

defaultState?

boolean

Returns

void

setRowPinning

setRowPinning: (updater) => void;

Defined in: features/row-pinning/rowPinningFeature.types.ts:94

Updates row pinning state with a next state or updater function.

Parameters

updater

Updater<RowPinningState>

Returns

void