row_pin

Function: row_pin()

ts
function row_pin<TFeatures, TData>(
   row, 
   position, 
   includeLeafRows?, 
   includeParentRows?): void;

Defined in: features/row-pinning/rowPinningFeature.utils.ts:286

Pins or unpins a row.

Optional flags let callers include parent rows or leaf rows when updating the row pinning state.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Parameters

row

Row\<`TFeatures`, `TData`\>

position

RowPinningPosition

includeLeafRows?

boolean

includeParentRows?

boolean

Returns

void

Example

ts
row_pin(row, 'top')