Back to Table

Column_ColumnPinning

docs/reference/interfaces/Column_ColumnPinning.md

8.21.31.8 KB
Original Source

Interface: Column_ColumnPinning

Defined in: features/column-pinning/columnPinningFeature.types.ts:41

Properties

getCanPin()

ts
getCanPin: () => boolean;

Defined in: features/column-pinning/columnPinningFeature.types.ts:45

Returns whether or not the column can be pinned.

Returns

boolean


getIsPinned()

ts
getIsPinned: () => ColumnPinningPosition;

Defined in: features/column-pinning/columnPinningFeature.types.ts:49

Returns the pinned position of the column. ('left', 'right' or false)

Returns

ColumnPinningPosition


getPinnedIndex()

ts
getPinnedIndex: () => number;

Defined in: features/column-pinning/columnPinningFeature.types.ts:53

Returns the numeric pinned index of the column within a pinned column group.

Returns

number


pin()

ts
pin: (position) => void;

Defined in: features/column-pinning/columnPinningFeature.types.ts:57

Pins a column to the 'left' or 'right', or unpins the column to the center if false is passed.

Parameters

position

ColumnPinningPosition

Returns

void