Table_Columns | TanStack Table Docs

Extended by

TFeatures extends TableFeatures

TData extends RowData

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

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

Normalizes options.columns into the table's nested column hierarchy.

Column<TFeatures, TData, unknown>[]

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

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

Flattens the nested column hierarchy, including parent/group columns.

Column<TFeatures, TData, unknown>[]

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

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

Returns a map of all flat columns by their ID.

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

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

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

Collects all terminal leaf columns, excluding parent/group columns.

Column<TFeatures, TData, unknown>[]

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

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

Returns a map of all leaf-node columns by their ID. This does not include parent columns.

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

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

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

Returns a single column by its ID.

string

| Column<TFeatures, TData, unknown> | undefined

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

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

Resolves built-in, feature-level, and user-defined default column options.

Partial<ColumnDef<TFeatures, TData, unknown>>