enableColumnPinningonColumnPinningChangeenablePinningsetColumnPinningresetColumnPinninggetIsSomeColumnsPinnedgetLeftHeaderGroupsgetCenterHeaderGroupsgetRightHeaderGroupsgetLeftFooterGroupsgetCenterFooterGroupsgetRightFooterGroupsgetLeftFlatHeadersgetCenterFlatHeadersgetRightFlatHeadersgetLeftLeafHeadersgetCenterLeafHeadersgetRightLeafHeadersgetLeftLeafColumnsgetRightLeafColumnsgetCenterLeafColumnsgetCanPingetPinnedIndexgetIsPinnedpingetLeftVisibleCellsgetRightVisibleCellsgetCenterVisibleCellsThe ability for a column to be pinned is determined by the following:
Pinning state is stored on the table using the following shape:
export type ColumnPinningPosition = false | 'left' | 'right' export type ColumnPinningState = { left?: string[] right?: string[] } export type ColumnPinningTableState = { columnPinning: ColumnPinningState } export type ColumnPinningPosition = false | 'left' | 'right' export type ColumnPinningState = { left?: string[] right?: string[] } export type ColumnPinningTableState = { columnPinning: ColumnPinningState } enableColumnPinning?: boolean enableColumnPinning?: boolean Enables/disables column pinning for all columns in the table.
onColumnPinningChange?: OnChangeFn<ColumnPinningState> onColumnPinningChange?: OnChangeFn<ColumnPinningState> If provided, this function will be called with an updaterFn when state.columnPinning changes. This overrides the default internal state management, so you will also need to supply state.columnPinning from your own managed state.
enablePinning?: boolean enablePinning?: boolean Enables/disables pinning for the column.
setColumnPinning: (updater: Updater<ColumnPinningState>) => void setColumnPinning: (updater: Updater<ColumnPinningState>) => void Sets or updates the state.columnPinning state.
resetColumnPinning: (defaultState?: boolean) => void resetColumnPinning: (defaultState?: boolean) => void Resets the columnPinning state to initialState.columnPinning, or true can be passed to force a default blank state reset to { left: [], right: [], }.
getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean Returns whether or not any columns are pinned. Optionally specify to only check for pinned columns in either the left or right position.
Note: Does not account for column visibility
getLeftHeaderGroups: () => HeaderGroup<TData>[] getLeftHeaderGroups: () => HeaderGroup<TData>[] Returns the left pinned header groups for the table.
getCenterHeaderGroups: () => HeaderGroup<TData>[] getCenterHeaderGroups: () => HeaderGroup<TData>[] Returns the unpinned/center header groups for the table.
getRightHeaderGroups: () => HeaderGroup<TData>[] getRightHeaderGroups: () => HeaderGroup<TData>[] Returns the right pinned header groups for the table.
getLeftFooterGroups: () => HeaderGroup<TData>[] getLeftFooterGroups: () => HeaderGroup<TData>[] Returns the left pinned footer groups for the table.
getCenterFooterGroups: () => HeaderGroup<TData>[] getCenterFooterGroups: () => HeaderGroup<TData>[] Returns the unpinned/center footer groups for the table.
getRightFooterGroups: () => HeaderGroup<TData>[] getRightFooterGroups: () => HeaderGroup<TData>[] Returns the right pinned footer groups for the table.
getLeftFlatHeaders: () => Header<TData>[] getLeftFlatHeaders: () => Header<TData>[] Returns a flat array of left pinned headers for the table, including parent headers.
getCenterFlatHeaders: () => Header<TData>[] getCenterFlatHeaders: () => Header<TData>[] Returns a flat array of unpinned/center headers for the table, including parent headers.
getRightFlatHeaders: () => Header<TData>[] getRightFlatHeaders: () => Header<TData>[] Returns a flat array of right pinned headers for the table, including parent headers.
getLeftLeafHeaders: () => Header<TData>[] getLeftLeafHeaders: () => Header<TData>[] Returns a flat array of leaf-node left pinned headers for the table.
getCenterLeafHeaders: () => Header<TData>[] getCenterLeafHeaders: () => Header<TData>[] Returns a flat array of leaf-node unpinned/center headers for the table.
getRightLeafHeaders: () => Header<TData>[] getRightLeafHeaders: () => Header<TData>[] Returns a flat array of leaf-node right pinned headers for the table.
getLeftLeafColumns: () => Column<TData>[] getLeftLeafColumns: () => Column<TData>[] Returns all left pinned leaf columns.
getRightLeafColumns: () => Column<TData>[] getRightLeafColumns: () => Column<TData>[] Returns all right pinned leaf columns.
getCenterLeafColumns: () => Column<TData>[] getCenterLeafColumns: () => Column<TData>[] Returns all center pinned (unpinned) leaf columns.
getCanPin: () => boolean getCanPin: () => boolean Returns whether or not the column can be pinned.
getPinnedIndex: () => number getPinnedIndex: () => number Returns the numeric pinned index of the column within a pinned column group.
getIsPinned: () => ColumnPinningPosition getIsPinned: () => ColumnPinningPosition Returns the pinned position of the column. ('left', 'right' or false)
pin: (position: ColumnPinningPosition) => void pin: (position: ColumnPinningPosition) => void Pins a column to the 'left' or 'right', or unpins the column to the center if false is passed.
getLeftVisibleCells: () => Cell<TData>[] getLeftVisibleCells: () => Cell<TData>[] Returns all left pinned leaf cells in the row.
getRightVisibleCells: () => Cell<TData>[] getRightVisibleCells: () => Cell<TData>[] Returns all right pinned leaf cells in the row.
getCenterVisibleCells: () => Cell<TData>[] getCenterVisibleCells: () => Cell<TData>[] Returns all center pinned (unpinned) leaf cells in the row.
