column_pin

function column_pin<TFeatures, TData, TValue>(column, position): void;

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

Moves this column's leaf column ids into a pinning region.

Pinning a group column pins all of its leaves. The leaf ids are first removed from both regions, then appended to the requested 'start' or 'end' region. Passing false unpins them back to the center.

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>

position#

ColumnPinningPosition

Returns#

void

Example#

column_pin(column, 'start')