Table_ColumnPinning

Defined in: features/column-pinning/columnPinningFeature.types.ts:98

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

_orderByColumnPinning

_orderByColumnPinning: <TItem>(items, getColumnId, getItemsByColumnId?) => TItem[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:114

Internal

Orders items that each belong to a leaf column, such as visible leaf columns or a row's visible cells: start-pinned items in pinning order, then unpinned items in their given order, then end-pinned items in pinning order. The core headers, row visible cells, and cell selection order through it.

getItemsByColumnId can return an existing lookup of the same items. It is only read when something is pinned.

Type Parameters

TItem

TItem

Parameters

items

TItem[]

getColumnId

(item) => string

getItemsByColumnId?

() => Record<string, TItem | undefined>

Returns

TItem[]

getCenterFlatHeaders

getCenterFlatHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:123

Builds flat center-region headers for columns that are not pinned, including parent headers.

Returns

Header<TFeatures, TData, unknown>[]

getCenterFooterGroups

getCenterFooterGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:127

Builds footer groups for the center region of unpinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getCenterHeaderGroups

getCenterHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:131

Builds header groups for the center region of unpinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getCenterLeafColumns

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

Defined in: features/column-pinning/columnPinningFeature.types.ts:135

Gets leaf columns that are not pinned start or end.

Returns

Column<TFeatures, TData, unknown>[]

getCenterLeafHeaders

getCenterLeafHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:139

Builds center-region leaf headers for columns that are not pinned.

Returns

Header<TFeatures, TData, unknown>[]

getCenterVisibleLeafColumns

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

Defined in: features/column-pinning/columnPinningFeature.types.ts:143

Lists visible leaf columns in the unpinned center region.

Returns

Column<TFeatures, TData, unknown>[]

getEndFlatHeaders

getEndFlatHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:177

Builds flat logical end-region headers for pinned columns, including parent headers.

Returns

Header<TFeatures, TData, unknown>[]

getEndFooterGroups

getEndFooterGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:181

Builds footer groups for logical end-pinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getEndHeaderGroups

getEndHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:185

Builds header groups for logical end-pinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getEndLeafColumns

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

Defined in: features/column-pinning/columnPinningFeature.types.ts:189

Gets leaf columns pinned to the logical end region in pinning-state order.

Returns

Column<TFeatures, TData, unknown>[]

getEndLeafHeaders

getEndLeafHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:193

Builds leaf headers for logical end-pinned columns.

Returns

Header<TFeatures, TData, unknown>[]

getEndVisibleLeafColumns

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

Defined in: features/column-pinning/columnPinningFeature.types.ts:197

Lists visible leaf columns in the logical end pinned region.

Returns

Column<TFeatures, TData, unknown>[]

getIsSomeColumnsPinned

getIsSomeColumnsPinned: (position?) => boolean;

Defined in: features/column-pinning/columnPinningFeature.types.ts:147

Checks whether any columns are pinned, optionally limited to one side.

Parameters

position?

ColumnPinningPosition

Returns

boolean

getPinnedLeafColumns

getPinnedLeafColumns: (position) => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:211

Returns pinned leaf columns for the requested pinning region.

Parameters

position

| ColumnPinningPosition | "center"

Returns

Column<TFeatures, TData, unknown>[]

getPinnedVisibleLeafColumns

getPinnedVisibleLeafColumns: (position) => Column<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:217

Lists visible leaf columns for the requested pinning region.

Parameters

position

| ColumnPinningPosition | "center"

Returns

Column<TFeatures, TData, unknown>[]

getStartFlatHeaders

getStartFlatHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:152

Builds flat logical start-region headers for pinned columns, including parent headers.

Returns

Header<TFeatures, TData, unknown>[]

getStartFooterGroups

getStartFooterGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:156

Builds footer groups for logical start-pinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getStartHeaderGroups

getStartHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:160

Builds header groups for logical start-pinned columns.

Returns

HeaderGroup<TFeatures, TData>[]

getStartLeafColumns

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

Defined in: features/column-pinning/columnPinningFeature.types.ts:164

Gets leaf columns pinned to the logical start region in pinning-state order.

Returns

Column<TFeatures, TData, unknown>[]

getStartLeafHeaders

getStartLeafHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: features/column-pinning/columnPinningFeature.types.ts:168

Builds leaf headers for logical start-pinned columns.

Returns

Header<TFeatures, TData, unknown>[]

getStartVisibleLeafColumns

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

Defined in: features/column-pinning/columnPinningFeature.types.ts:172

Lists visible leaf columns in the logical start pinned region.

Returns

Column<TFeatures, TData, unknown>[]

resetColumnPinning

resetColumnPinning: (defaultState?) => void;

Defined in: features/column-pinning/columnPinningFeature.types.ts:203

Resets columnPinning to initialState.columnPinning.

Pass true to ignore initial state and reset to empty start/end arrays.

Parameters

defaultState?

boolean

Returns

void

setColumnPinning

setColumnPinning: (updater) => void;

Defined in: features/column-pinning/columnPinningFeature.types.ts:207

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

Parameters

updater

Updater<ColumnPinningState>

Returns

void