Back to Table

Column_Column

docs/reference/interfaces/Column_Column.md

8.21.34.8 KB
Original Source

Interface: Column_Column<TFeatures, TData, TValue>

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

Extends

Extended by

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends CellData = CellData

Properties

accessorFn?

ts
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_CoreProperties.accessorFn


columnDef

ts
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_CoreProperties.columnDef


columns

ts
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_CoreProperties.columns


depth

ts
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_CoreProperties.depth


getFlatColumns()

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

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

Returns the flattened array of this column and all child/grand-child columns for this column.

Returns

Column<TFeatures, TData, TValue>[]


getLeafColumns()

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

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

Returns an array of all leaf-node columns for this column. If a column has no children, it is considered the only leaf-node column.

Returns

Column<TFeatures, TData, TValue>[]


id

ts
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_CoreProperties.id


parent?

ts
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_CoreProperties.parent


table

ts
table: Table_Internal<TFeatures, TData>;

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

Reference to the parent table instance.

Inherited from

Column_CoreProperties.table