column_getIsPinned

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

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

Reads this column's current pinning region.

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

start and end are logical positions. In LTR languages/layouts, start usually corresponds to left and end to right. In RTL languages/layouts, start usually corresponds to right and end to left.

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)