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

TableOptions_RowSorting

Interface: TableOptions_RowSorting

Defined in: features/row-sorting/rowSortingFeature.types.ts:143

Properties

enableMultiRemove?

ts
optional enableMultiRemove: boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:147

Enables/disables the ability to remove multi-sorts


enableMultiSort?

ts
optional enableMultiSort: boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:151

Enables/Disables multi-sorting for the table.


enableSorting?

ts
optional enableSorting: boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:155

Enables/Disables sorting for the table.


enableSortingRemoval?

ts
optional enableSortingRemoval: boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:161

Enables/Disables the ability to remove sorting for the table.

  • If true then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ...
  • If false then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ...

isMultiSortEvent()?

ts
optional isMultiSortEvent: (e) => boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:165

Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return true if the event should trigger a multi-sort.

Parameters

e

unknown

Returns

boolean


manualSorting?

ts
optional manualSorting: boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:169

Enables manual sorting for the table. If this is true, you will be expected to sort your data before it is passed to the table. This is useful if you are doing server-side sorting.


maxMultiSortColCount?

ts
optional maxMultiSortColCount: number;

Defined in: features/row-sorting/rowSortingFeature.types.ts:173

Set a maximum number of columns that can be multi-sorted.


onSortingChange?

ts
optional onSortingChange: OnChangeFn<SortingState>;

Defined in: features/row-sorting/rowSortingFeature.types.ts:177

If provided, this function will be called with an updaterFn when state.sorting changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.


sortDescFirst?

ts
optional sortDescFirst: boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:181

If true, all sorts will default to descending as their first toggle state.