Interface: Header_Header<TFeatures, TData, TValue>

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

Extends

• Header_CoreProperties<TFeatures, TData, TValue>

Extended by

• Header_Core

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:57

The col-span for the header.

Inherited from

Header_CoreProperties.colSpan

column

column: Column<TFeatures, TData, TValue>;

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

The header's associated column object.

Inherited from

Header_CoreProperties.column

depth

depth: number;

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

The depth of the header, zero-indexed based.

Inherited from

Header_CoreProperties.depth

getContext()

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.

Returns

HeaderContext<TFeatures, TData, TValue>

getLeafHeaders()

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

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

Returns the leaf headers hierarchically nested under this header.

Returns

Header<TFeatures, TData, TValue>[]

headerGroup

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

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

The header's associated header group object.

Inherited from

Header_CoreProperties.headerGroup

id

id: string;

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

The unique identifier for the header.

Inherited from

Header_CoreProperties.id

index

index: number;

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

The index for the header within the header group.

Inherited from

Header_CoreProperties.index

isPlaceholder

isPlaceholder: boolean;

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

A boolean denoting if the header is a placeholder header.

Inherited from

Header_CoreProperties.isPlaceholder

placeholderId?

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.

Inherited from

Header_CoreProperties.placeholderId

rowSpan

rowSpan: number;

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

The row-span for the header.

Inherited from

Header_CoreProperties.rowSpan

subHeaders

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.

Inherited from

Header_CoreProperties.subHeaders

table

table: Table<TFeatures, TData>;

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

Reference to the parent table instance.

Inherited from

Header_CoreProperties.table