Function: column_getIsPinned()#

function column_getIsPinned<TFeatures, TData, TValue>(column): ColumnPinningPosition;

function column_getIsPinned<TFeatures, TData, TValue>(column): ColumnPinningPosition;

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

Reads this column's current pinning region.

Group columns report 'left' or 'right' when any leaf column is pinned in that region. Unpinned columns return false.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

column#

Column_Internal<TFeatures, TData, TValue>

Returns#

ColumnPinningPosition

Example#

const position = column_getIsPinned(column)

const position = column_getIsPinned(column)