Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Table API Reference
Column API Reference
Row API Reference
Cell API Reference
Header API Reference
Features API Reference
Legacy API Reference
Enterprise
Features API Reference

Table_RowPinning

Interface: Table_RowPinning<TFeatures, TData>

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getBottomRows()

ts
getBottomRows: () => Row<TFeatures, TData>[];

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

Returns all bottom pinned rows.

Returns

Row<TFeatures, TData>[]


getCenterRows()

ts
getCenterRows: () => Row<TFeatures, TData>[];

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

Returns all rows that are not pinned to the top or bottom.

Returns

Row<TFeatures, TData>[]


getIsSomeRowsPinned()

ts
getIsSomeRowsPinned: (position?) => boolean;

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

Returns whether or not any rows are pinned. Optionally specify to only check for pinned rows in either the top or bottom position.

Parameters

position?

RowPinningPosition

Returns

boolean


getTopRows()

ts
getTopRows: () => Row<TFeatures, TData>[];

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

Returns all top pinned rows.

Returns

Row<TFeatures, TData>[]


resetRowPinning()

ts
resetRowPinning: (defaultState?) => void;

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

Resets the rowPinning state to initialState.rowPinning, or true can be passed to force a default blank state reset to { top: [], bottom: [], }.

Parameters

defaultState?

boolean

Returns

void


setRowPinning()

ts
setRowPinning: (updater) => void;

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

Sets or updates the state.rowPinning state.

Parameters

updater

Updater<RowPinningState>

Returns

void