column_getIndex

Function: column_getIndex()

ts
function column_getIndex<TFeatures, TData, TValue>(column, position?): number;

Defined in: features/column-ordering/columnOrderingFeature.utils.ts:37

Finds this column's index within a visible pinning region.

Pass 'left', 'center', or 'right' to search that region; omit the position to search the full visible leaf column list.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends unknown = unknown

Parameters

column

Column_Internal\<`TFeatures`, `TData`, `TValue`\>

position?

ColumnPinningPosition | "center"

Returns

number

Example

ts
const index = column_getIndex(column, 'center')