Interface: Row_RowPinning

Defined in: features/row-pinning/rowPinningFeature.types.ts:38

Properties

getCanPin()

getCanPin: () => boolean;

Defined in: features/row-pinning/rowPinningFeature.types.ts:42

Returns whether or not the row can be pinned.

Returns

boolean

getIsPinned()

getIsPinned: () => RowPinningPosition;

Defined in: features/row-pinning/rowPinningFeature.types.ts:46

Returns the pinned position of the row. ('top', 'bottom' or false)

Returns

RowPinningPosition

getPinnedIndex()

getPinnedIndex: () => number;

Defined in: features/row-pinning/rowPinningFeature.types.ts:50

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

Returns

number

pin()

pin: (position, includeLeafRows?, includeParentRows?) => void;

Defined in: features/row-pinning/rowPinningFeature.types.ts:54

Pins a row to the 'top' or 'bottom', or unpins the row to the center if false is passed.

Parameters

position

RowPinningPosition

includeLeafRows?

boolean

includeParentRows?

boolean

Returns

void