Header_Core

Defined in: types/Header.ts:7

Extends

• Header_Header<TFeatures, TData, TValue>

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends CellData = CellData

Properties

colSpan

colSpan: number;

Defined in: core/headers/coreHeadersFeature.types.ts:59

The col-span for the header.

Inherited from

Header_Header.colSpan

column

column: Column<TFeatures, TData, TValue>;

Defined in: core/headers/coreHeadersFeature.types.ts:63

The header's associated column object.

Inherited from

Header_Header.column

depth

depth: number;

Defined in: core/headers/coreHeadersFeature.types.ts:67

The depth of the header, zero-indexed.

Inherited from

Header_Header.depth

getContext

getContext: () => HeaderContext<TFeatures, TData, TValue>;

Defined in: core/headers/coreHeadersFeature.types.ts:122

Returns the rendering context (or props) for column-based components like headers, footers and filters.

Returns

HeaderContext<TFeatures, TData, TValue>

Inherited from

Header_Header.getContext

getLeafHeaders

getLeafHeaders: () => Header<TFeatures, TData, TValue>[];

Defined in: core/headers/coreHeadersFeature.types.ts:126

Returns the leaf headers hierarchically nested under this header.

Returns

Header<TFeatures, TData, TValue>[]

Inherited from

Header_Header.getLeafHeaders

headerGroup

headerGroup: HeaderGroup<TFeatures, TData> | null;

Defined in: core/headers/coreHeadersFeature.types.ts:71

The header's associated header group object.

Inherited from

Header_Header.headerGroup

id

id: string;

Defined in: core/headers/coreHeadersFeature.types.ts:75

The unique identifier for the header.

Inherited from

Header_Header.id

index

index: number;

Defined in: core/headers/coreHeadersFeature.types.ts:79

The index for the header within the header group.

Inherited from

Header_Header.index

isPlaceholder

isPlaceholder: boolean;

Defined in: core/headers/coreHeadersFeature.types.ts:87

A boolean denoting if the header is a placeholder header. Placeholder headers fill the rows above a shallow leaf column's real header so that every header group row accounts for every visible column. Render them as empty cells, or use header.rowSpan to merge each chain of placeholders into one vertically spanning header cell.

Inherited from

Header_Header.isPlaceholder

placeholderId?

optional placeholderId?: string;

Defined in: core/headers/coreHeadersFeature.types.ts:91

If the header is a placeholder header, this will be a unique header ID that does not conflict with any other headers across the table.

Inherited from

Header_Header.placeholderId

rowSpan

rowSpan: number;

Defined in: core/headers/coreHeadersFeature.types.ts:103

The number of header group rows the header should span when merging header cells vertically. A leaf column that is shallower than the deepest leaf column produces a chain of placeholder headers above its real header; the placeholder at the top of the chain reports the chain's full span, and every header it covers (including the real leaf header in the bottom row) reports 0. To merge vertically, skip headers with a rowSpan of 0 and render every other header with the rowSpan attribute and its column's header content, even when it is a placeholder. Headers in even column trees always report 1.

Inherited from

Header_Header.rowSpan

subHeaders

subHeaders: Header<TFeatures, TData, TValue>[];

Defined in: core/headers/coreHeadersFeature.types.ts:107

The header's hierarchical sub/child headers. Will be empty if the header's associated column is a leaf-column.

Inherited from

Header_Header.subHeaders

table

table: Table_Internal<TFeatures, TData>;

Defined in: core/headers/coreHeadersFeature.types.ts:111

Reference to the parent table instance.

Inherited from

Header_Header.table