Table_ColumnOrdering

Defined in: features/column-ordering/columnOrderingFeature.types.ts:66

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

getColumnIndexes#

getColumnIndexes: () => ColumnIndexes;

Defined in: features/column-ordering/columnOrderingFeature.types.ts:76

Builds column-id to index records for each visible pinning region.

This is the memoized source that column.getIndex reads from; most apps will not need to call it directly.

Returns#

ColumnIndexes

getOrderColumnsFn#

getOrderColumnsFn: () => (columns) => Column<TFeatures, TData, unknown>[];

Defined in: features/column-ordering/columnOrderingFeature.types.ts:83

Returns a function that orders leaf columns by columnOrder, after moving grouped columns as groupedColumnMode sets.

Leaf column order reads it; most apps will not need to call it directly.

Returns#

(columns) => Column<TFeatures, TData, unknown>[]

resetColumnOrder#

resetColumnOrder: (defaultState?) => void;

Defined in: features/column-ordering/columnOrderingFeature.types.ts:91

Resets columnOrder to initialState.columnOrder.

Pass true to ignore initial state and reset to [].

Parameters#

defaultState?#

boolean

Returns#

void

setColumnOrder#

setColumnOrder: (updater) => void;

Defined in: features/column-ordering/columnOrderingFeature.types.ts:95

Updates column order state with a next ordered id array or updater function.

Parameters#

updater#

Updater<ColumnOrderState>

Returns#

void