ITableGrandTotalHeaderValue
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Header cell labeling a **grand-total row** (usually located in the first columns).
**Visual example:**
| Q1 | Q2 | ColSum Σ |
-----------+-----+-----+----------+
USA | 100 | 120 | 220 |
CAN | 80 | 90 | 170 |
RowSum Σ | 180 | 210 | 390 | <- RowSum Σ is grandTotalHeader
export interface ITableGrandTotalHeaderValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ITableAttributeColumnDefinition | ITableMeasureGroupHeaderColumnDefinition | (ALPHA) Column context - typically an attribute column or measure header column where the grand total label appears. | ||
number | (ALPHA) Zero-based column position in the | ||
string | null | (ALPHA) Display text for the grand total row label (e.g., “Sum”, “Total”). Usually shows the aggregation type or a localized “Total” label. | ||
(ALPHA) Row context - grand-total row since this header cell is labeling a grand-total row. | |||
number | (ALPHA) Zero-based row position in the | ||
“grandTotalHeader” | (ALPHA) Discriminator literal for narrowing the |
Property details
ITableGrandTotalHeaderValue.columnDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Column context - typically an attribute column or measure header column where the grand total label appears.
columnDefinition: ITableAttributeColumnDefinition | ITableMeasureGroupHeaderColumnDefinition;
ITableGrandTotalHeaderValue.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. Usually points to the first attribute column (leftmost) or measure header column (when measures are transposed).
columnIndex: number;
ITableGrandTotalHeaderValue.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 grand total row label (e.g., “Sum”, “Total”). Usually shows the aggregation type or a localized “Total” label.
formattedValue: string | null;
ITableGrandTotalHeaderValue.rowDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Row context - grand-total row since this header cell is labeling a grand-total row.
rowDefinition: ITableGrandTotalRowDefinition;
ITableGrandTotalHeaderValue.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. Points to a grand-total row that this header cell labels.
rowIndex: number;
ITableGrandTotalHeaderValue.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: "grandTotalHeader";