ITableTotalHeaderValue
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Cell that represents total header. Each cell corresponds to one IResultTotalHeader and labels the total for that specific row / column.
**Visual example**
Attribute | Value |
-----------+-------+
USA | 100 |
Sum A | 80 | <- "Sum A" is totalHeader
export interface ITableTotalHeaderValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ITableValueColumnDefinition | ITableSubtotalColumnDefinition | ITableMeasureGroupHeaderColumnDefinition | ITableAttributeColumnDefinition | (ALPHA) Column context - value column, subtotal column, measure group header column, or attribute column. | ||
number | (ALPHA) Zero-based column position in the | ||
string | null | (ALPHA) Display text for the total header (e.g., “Sum”, “Avg”, “Max”). | ||
(ALPHA) Row context - subtotal or value row. | |||
number | (ALPHA) Zero-based row position in the | ||
“totalHeader” | (ALPHA) Discriminator literal for narrowing the | ||
(ALPHA) The raw |
Property details
ITableTotalHeaderValue.columnDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Column context - value column, subtotal column, measure group header column, or attribute column.
columnDefinition: ITableValueColumnDefinition | ITableSubtotalColumnDefinition | ITableMeasureGroupHeaderColumnDefinition | ITableAttributeColumnDefinition;
ITableTotalHeaderValue.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 in the data matrix. Points to the measure header column when measures are transposed.
columnIndex: number;
ITableTotalHeaderValue.formattedValuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Display text for the total header (e.g., “Sum”, “Avg”, “Max”).
formattedValue: string | null;
ITableTotalHeaderValue.rowDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Row context - subtotal or value row.
rowDefinition: ITableValueRowDefinition | ITableSubtotalRowDefinition;
ITableTotalHeaderValue.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 in the data matrix. Usually points to a subtotal or grand-total row.
rowIndex: number;
ITableTotalHeaderValue.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: "totalHeader";
ITableTotalHeaderValue.valuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The raw IResultTotalHeader object containing total metadata like totalType, measureIndex, etc.
value: IResultTotalHeader;