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

ColumnDef_RowSorting

Interface: ColumnDef_RowSorting<TFeatures, TData>

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

enableMultiSort?

ts
optional enableMultiSort: boolean;

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

Enables/Disables multi-sorting for this column.


enableSorting?

ts
optional enableSorting: boolean;

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

Enables/Disables sorting for this column.


invertSorting?

ts
optional invertSorting: boolean;

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

Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring


sortDescFirst?

ts
optional sortDescFirst: boolean;

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

Set to true for sorting toggles on this column to start in the descending direction.


sortFn?

ts
optional sortFn: SortFnOption<TFeatures, TData>;

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

The sorting function to use with this column.

  • A string referencing a built-in sorting function
  • A custom sorting function

sortUndefined?

ts
optional sortUndefined: false | 1 | -1 | "first" | "last";

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

The priority of undefined values when sorting this column.

  • false
    • Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies)
  • -1
    • Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list)
  • 1
    • Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list)