IInternalDataTableHeader
interface
Data Display
Normalised header descriptor used internally by <OrigamDataTable> after the raw IDataTableHeader array has been processed. Extends IDataTableHeader (omitting key, value, children) with resolved types and layout hints.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- keyrequiredstring | null
- Resolved column key used for sorting and filtering. null for columns without a key.
- valuerequiredTSelectItemKey | null
- Resolved value accessor for reading cell data from a row object. null when no value is defined.
- sortablerequiredboolean
- Whether the column is sortable. Derived from the raw header definition during normalisation.
- fixedOffsetnumber
- Pixel offset applied to sticky fixed columns.
- lastFixedboolean
- Marks the last fixed column so a drop-shadow separator can be rendered.
- nowrapboolean
- Prevents text wrapping inside the header cell.
- paddingstring | number
- Override cell padding for this column.
- colspannumber
- HTML colspan for merged header cells.
- rowspannumber
- HTML rowspan for merged header cells.
- childrenArray<IInternalDataTableHeader>
- Nested sub-headers for grouped column structures.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Reading a resolved header in a custom header slot