Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
WorkOS
Clerk
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
Static Functions API Reference
Legacy API Reference

Row_RowSelection

Interface: Row_RowSelection

Defined in: features/row-selection/rowSelectionFeature.types.ts:54

Properties

getCanMultiSelect()

ts
getCanMultiSelect: () => boolean;
getCanMultiSelect: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:58

Checks whether this row can be selected alongside other rows.

Returns

boolean


getCanSelect()

ts
getCanSelect: () => boolean;
getCanSelect: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:62

Checks whether this row can currently be selected.

Returns

boolean


getCanSelectSubRows()

ts
getCanSelectSubRows: () => boolean;
getCanSelectSubRows: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:66

Checks whether selecting this row should also select its subRows.

Returns

boolean


getIsAllSubRowsSelected()

ts
getIsAllSubRowsSelected: () => boolean;
getIsAllSubRowsSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:70

Checks whether all selectable descendants are selected.

Returns

boolean


getIsSelected()

ts
getIsSelected: () => boolean;
getIsSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:74

Checks whether this row id is selected.

Returns

boolean


getIsSomeSelected()

ts
getIsSomeSelected: () => boolean;
getIsSomeSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:78

Checks whether some selectable descendants are selected.

Returns

boolean


getToggleSelectedHandler()

ts
getToggleSelectedHandler: () => (event) => void;
getToggleSelectedHandler: () => (event) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:82

Creates a checkbox-style handler that toggles this row's selected state.

Returns

ts
(event): void;
(event): void;
Parameters
event

unknown

Returns

void


toggleSelected()

ts
toggleSelected: (value?, opts?) => void;
toggleSelected: (value?, opts?) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:86

Selects/deselects the row.

Parameters

value?

boolean

opts?
selectChildren?

boolean

Returns

void