TanStack

Table_ColumnOrdering

Interface: Table_ColumnOrdering<_TFeatures, _TData>

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

Type Parameters

_TFeatures

_TFeatures extends TableFeatures

_TData

_TData extends RowData

Properties

getColumnIndexes()

ts
getColumnIndexes: () => ColumnIndexes;

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

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


resetColumnOrder()

ts
resetColumnOrder: (defaultState?) => void;

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

Resets columnOrder to initialState.columnOrder.

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

Parameters

defaultState?

boolean

Returns

void


setColumnOrder()

ts
setColumnOrder: (updater) => void;

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

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

Parameters

updater

Updater<ColumnOrderState>

Returns

void