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
Table API Reference

Table_Columns

Interface: Table_Columns<TFeatures, TData>

Defined in: core/columns/coreColumnsFeature.types.ts:75

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

getAllColumns()

ts
getAllColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: core/columns/coreColumnsFeature.types.ts:90

Returns all columns in the table in their normalized and nested hierarchy.

Returns

Column<TFeatures, TData, unknown>[]


getAllFlatColumns()

ts
getAllFlatColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: core/columns/coreColumnsFeature.types.ts:94

Returns all columns in the table flattened to a single level.

Returns

Column<TFeatures, TData, unknown>[]


getAllFlatColumnsById()

ts
getAllFlatColumnsById: () => Record<string, Column<TFeatures, TData, unknown>>;

Defined in: core/columns/coreColumnsFeature.types.ts:82

Returns a map of all flat columns by their ID.

Returns

Record<string, Column<TFeatures, TData, unknown>>


getAllLeafColumns()

ts
getAllLeafColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: core/columns/coreColumnsFeature.types.ts:98

Returns all leaf-node columns in the table flattened to a single level. This does not include parent columns.

Returns

Column<TFeatures, TData, unknown>[]


getColumn()

ts
getColumn: (columnId) => 
  | Column<TFeatures, TData, unknown>
  | undefined;

Defined in: core/columns/coreColumnsFeature.types.ts:102

Returns a single column by its ID.

Parameters

columnId

string

Returns

| Column<TFeatures, TData, unknown> | undefined


getDefaultColumnDef()

ts
getDefaultColumnDef: () => Partial<ColumnDef<TFeatures, TData, unknown>>;

Defined in: core/columns/coreColumnsFeature.types.ts:86

Returns the default column options to use for all column defs supplied to the table.

Returns

Partial<ColumnDef<TFeatures, TData, unknown>>