ITableAttributeHeaderValue
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Cell located in ITableAttributeColumnDefinition – typically the leftmost part of the table describing the current row’s attribute values.
It represents a single IResultAttributeHeader coming from the execution response and can be present in both value rows and subtotal rows.
**Visual example**
Attribute | Measure |
-----------+---------+
USA | 100 | <- "USA" is attributeHeader
export interface ITableAttributeHeaderValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) Full column context describing which attribute column this cell belongs to. Always an attribute column since this interface is for attribute headers. | |||
number | (ALPHA) Zero-based column position of this cell in the final | ||
string | null | (ALPHA) Attribute element value ready to be rendered. (e.g. “United States”) | ||
(ALPHA) Full row context describing which row this cell belongs to (value, subtotal, or grand-total row). | |||
number | (ALPHA) Zero-based row position of this cell in the final | ||
“attributeHeader” | (ALPHA) Discriminator literal for narrowing the | ||
(ALPHA) The raw |
Property details
ITableAttributeHeaderValue.columnDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Full column context describing which attribute column this cell belongs to. Always an attribute column since this interface is for attribute headers.
columnDefinition: ITableAttributeColumnDefinition;
ITableAttributeHeaderValue.columnIndexpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Zero-based column position of this cell in the final data matrix.
columnIndex: number;
ITableAttributeHeaderValue.formattedValuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Attribute element value ready to be rendered. (e.g. “United States”)
formattedValue: string | null;
ITableAttributeHeaderValue.rowDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Full row context describing which row this cell belongs to (value, subtotal, or grand-total row).
rowDefinition: ITableValueRowDefinition | ITableSubtotalRowDefinition;
ITableAttributeHeaderValue.rowIndexpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Zero-based row position of this cell in the final data matrix.
rowIndex: number;
ITableAttributeHeaderValue.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Discriminator literal for narrowing the ITableDataValue union.
type: "attributeHeader";
ITableAttributeHeaderValue.valuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The raw IResultAttributeHeader object from the execution response.
value: IResultAttributeHeader;