Interface: Header_Core<TFeatures, TData, TValue>#

Defined in: types/Header.ts:17

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;

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>;

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;

depth: number;

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

The depth of the header, zero-indexed based.

Inherited from#

Header_Header.depth

getContext()#

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

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

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

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>[];

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

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

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;

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;

id: string;

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

The unique identifier for the header.

Inherited from#

Header_Header.id

index#

index: number;

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;

isPlaceholder: boolean;

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

A boolean denoting if the header is a placeholder header.

Inherited from#

Header_Header.isPlaceholder

placeholderId?#

optional placeholderId: string;

optional placeholderId: string;

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

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;

rowSpan: number;

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

The row-span for the header.

Inherited from#

Header_Header.rowSpan

subHeaders#

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

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

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

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<TFeatures, TData>;

table: Table<TFeatures, TData>;

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

Reference to the parent table instance.

Inherited from#

Header_Header.table