ITableGrandTotalMeasureValue
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Numeric cell containing **grand totals** – totals across rows or columns.
**Visual example**
// Column grand total:
| Q1 | ColSum Σ |
-----------+-----+----------+
USA | 100 | 220 | <- 220 is grandTotalValue
// Row grand total:
| Q1 | Q2 |
-----------+-----+-----+
USA | 100 | 120 |
RowSum Σ | 180 | 210 | <- 180 and 210 are grandTotalValue cells
export interface ITableGrandTotalMeasureValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ITableValueColumnDefinition | ITableGrandTotalColumnDefinition | ITableMeasureGroupValueColumnDefinition | (ALPHA) Column context - value column, grand-total column, or measure group value column. | ||
number | (ALPHA) Zero-based column position in the | ||
string | null | (ALPHA) Human-readable formatted grand total value (e.g., “$10,000.00”). Uses the measure’s format string and locale settings. | ||
(ALPHA) Row context - value or grand-total row. | |||
number | (ALPHA) Zero-based row position in the | ||
“grandTotalValue” | (ALPHA) Discriminator literal for narrowing the | ||
(ALPHA) Raw aggregated grand total value from the backend. Result of aggregating across all rows or columns for this measure. |
Property details
ITableGrandTotalMeasureValue.columnDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Column context - value column, grand-total column, or measure group value column.
columnDefinition: ITableValueColumnDefinition | ITableGrandTotalColumnDefinition | ITableMeasureGroupValueColumnDefinition;
ITableGrandTotalMeasureValue.columnIndexpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Zero-based column position in the data matrix.
columnIndex: number;
ITableGrandTotalMeasureValue.formattedValuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Human-readable formatted grand total value (e.g., “$10,000.00”). Uses the measure’s format string and locale settings.
formattedValue: string | null;
ITableGrandTotalMeasureValue.rowDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Row context - value or grand-total row.
rowDefinition: ITableValueRowDefinition | ITableGrandTotalRowDefinition;
ITableGrandTotalMeasureValue.rowIndexpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Zero-based row position in the data matrix.
rowIndex: number;
ITableGrandTotalMeasureValue.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Discriminator literal for narrowing the ITableDataValue union.
type: "grandTotalValue";
ITableGrandTotalMeasureValue.valuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Raw aggregated grand total value from the backend. Result of aggregating across all rows or columns for this measure.
value: DataValue;