Defined in: types/Header.ts:17

• Header_Header<TFeatures, TData, TValue>

TFeatures extends TableFeatures

TData extends RowData

TValue extends CellData = CellData

colSpan: number;

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

The col-span for the header.

Header_Header.colSpan

column: Column<TFeatures, TData, TValue>;

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

The header's associated column object.

Header_Header.column

depth: number;

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

The depth of the header, zero-indexed based.

Header_Header.depth

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

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

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

HeaderContext<TFeatures, TData, TValue>

Header_Header.getContext

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

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

Returns the leaf headers hierarchically nested under this header.

Header<TFeatures, TData, TValue>[]

Header_Header.getLeafHeaders

headerGroup: 
  | HeaderGroup<TFeatures, TData>
  | null;

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

The header's associated header group object.

Header_Header.headerGroup

id: string;

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

The unique identifier for the header.

Header_Header.id

index: number;

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

The index for the header within the header group.

Header_Header.index

isPlaceholder: boolean;

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

A boolean denoting if the header is a placeholder header.

Header_Header.isPlaceholder

optional placeholderId: string;

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

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.

Header_Header.placeholderId

rowSpan: number;

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

The row-span for the header.

Header_Header.rowSpan

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

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

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

Header_Header.subHeaders

table: Table<TFeatures, TData>;

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

Reference to the parent table instance.

Header_Header.table