Column Pinning

The column pinning feature provides methods and state for pinning columns to the left or right side of the table. These properties are available on the table instance when using the column pinning feature. See the column pinning guide for usage examples and configuration details.

Prop	Type
getCenterLeafColumns Returns all center pinned (unpinned) leaf columns.	() => Column< TData, unknown, ColumnMeta >[]
getIsSomeColumnsPinned Returns whether any columns are pinned. Optionally specify to only check for pinned columns in either the `left` or `right` position.	( position?: \| false \| 'left' \| 'right', ) => boolean
getLeftLeafColumns Returns all left pinned leaf columns.	() => Column< TData, unknown, ColumnMeta >[]
getRightLeafColumns Returns all right pinned leaf columns.	() => Column< TData, unknown, ColumnMeta >[]
resetColumnPinning Resets the `columnPinning` state to `initialState.columnPinning`, or `true` can be passed to force a default blank state reset to `{ left: [], right: [], }` .	( defaultState?: boolean, ) => void
setColumnPinning Sets or updates the `state.columnPinning` state.	( updater: Updater<ColumnPinningState>, ) => void

getCenterLeafColumns

Type

() => Column<
  TData,
  unknown,
  ColumnMeta
>[]

Description

Returns all center pinned (unpinned) leaf columns.

getIsSomeColumnsPinned

Type

(
  position?:
    | false
    | 'left'
    | 'right',
) => boolean

Description

Returns whether any columns are pinned. Optionally specify to only check for pinned columns in either the left or right position.

getLeftLeafColumns

Type

() => Column<
  TData,
  unknown,
  ColumnMeta
>[]

Description

Returns all left pinned leaf columns.

getRightLeafColumns

Type

() => Column<
  TData,
  unknown,
  ColumnMeta
>[]

Description

Returns all right pinned leaf columns.

resetColumnPinning

Type

(
  defaultState?: boolean,
) => void

Description

Resets the columnPinning state to initialState.columnPinning, or true can be passed to force a default blank state reset to

{ left: [], right: [], }

setColumnPinning

Type

(
  updater: Updater<ColumnPinningState>,
) => void

Description

Sets or updates the state.columnPinning state.

Column Order

Column Sizing