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

column_getAutoSortDir

ts
function column_getAutoSortDir<TFeatures, TData, TValue>(column): "asc" | "desc";
function column_getAutoSortDir<TFeatures, TData, TValue>(column): "asc" | "desc";

Defined in: features/row-sorting/rowSortingFeature.utils.ts:183

Chooses the default first sort direction from sampled filtered row values.

The first non-nullish value among the sampled rows decides: string columns start ascending so alphabetical order is natural; other value types (or columns with no non-nullish sample) start descending. Sampling past leading nullish values keeps the toggle cycle stable when sorting or a data swap moves an empty value into the first row.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends unknown = unknown

Parameters

column

Column_Internal<TFeatures, TData, TValue>

Returns

"asc" | "desc"

Example

ts
const direction = column_getAutoSortDir(column)
const direction = column_getAutoSortDir(column)