Back to Table

Header_CoreProperties

docs/reference/interfaces/Header_CoreProperties.md

8.21.33.7 KB
Original Source

Interface: Header_CoreProperties<TFeatures, TData, TValue>

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

Extended by

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends CellData = CellData

Properties

colSpan

ts
colSpan: number;

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

The col-span for the header.


column

ts
column: Column<TFeatures, TData, TValue>;

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

The header's associated column object.


depth

ts
depth: number;

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

The depth of the header, zero-indexed based.


headerGroup

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

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

The header's associated header group object.


id

ts
id: string;

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

The unique identifier for the header.


index

ts
index: number;

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

The index for the header within the header group.


isPlaceholder

ts
isPlaceholder: boolean;

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

A boolean denoting if the header is a placeholder header.


placeholderId?

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


rowSpan

ts
rowSpan: number;

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

The row-span for the header.


subHeaders

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


table

ts
table: Table<TFeatures, TData>;

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

Reference to the parent table instance.