Column_Core

Defined in: types/Column.ts:18

Extends

• Column_Column<TFeatures, TData, TValue>

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue = unknown

Properties

accessorFn?

optional accessorFn?: AccessorFn<TData, TValue>;

optional accessorFn?: AccessorFn<TData, TValue>;

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

The resolved accessor function to use when extracting the value for the column from each row. Will only be defined if the column def has a valid accessor key or function defined.

Inherited from

Column_Column.accessorFn

columnDef

columnDef: ColumnDef<TFeatures, TData, TValue>;

columnDef: ColumnDef<TFeatures, TData, TValue>;

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

The original column def used to create the column.

Inherited from

Column_Column.columnDef

columns

columns: Column<TFeatures, TData, TValue>[];

columns: Column<TFeatures, TData, TValue>[];

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

The child column (if the column is a group column). Will be an empty array if the column is not a group column.

Inherited from

Column_Column.columns

depth

depth: number;

depth: number;

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

The depth of the column (if grouped) relative to the root column def array.

Inherited from

Column_Column.depth

getFlatColumns

getFlatColumns: () => Column<TFeatures, TData, TValue>[];

getFlatColumns: () => Column<TFeatures, TData, TValue>[];

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

Flattens this column and every descendant column into a single array.

Returns

Column<TFeatures, TData, TValue>[]

Inherited from

Column_Column.getFlatColumns

getLeafColumns

getLeafColumns: () => Column<TFeatures, TData, TValue>[];

getLeafColumns: () => Column<TFeatures, TData, TValue>[];

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

Collects the terminal leaf columns below this column, or the column itself when it has no children.

Returns

Column<TFeatures, TData, TValue>[]

Inherited from

Column_Column.getLeafColumns

id

id: string;

id: string;

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

The resolved unique identifier for the column resolved in this priority:

• A manual id property from the column def
• The accessor key from the column def
• The header string from the column def

Inherited from

Column_Column.id

parent?

optional parent?: Column<TFeatures, TData, TValue>;

optional parent?: Column<TFeatures, TData, TValue>;

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

The parent column for this column. Will be undefined if this is a root column.

Inherited from

Column_Column.parent

table

table: Table_Internal<TFeatures, TData>;

table: Table_Internal<TFeatures, TData>;

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

Reference to the parent table instance.

Inherited from

Column_Column.table