ITableSubtotalMeasureValue
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Numeric cell containing **subtotals** aggregated across sibling rows/columns.
**Visual example**
// Row subtotal:
| Sales |
-----------+--------+
USA | 100 |
Sum A | 170 | <- 170 is subtotalValue
// Column subtotal:
| Q1 | Sum A |
-----------+-----+---------+
USA | 100 | 220 | <- 220 is subtotalValue
export interface ITableSubtotalMeasureValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ITableValueColumnDefinition | ITableSubtotalColumnDefinition | (ALPHA) Column context - value column or subtotal column. | ||
number | (ALPHA) Zero-based column position in the | ||
string | null | (ALPHA) Human-readable formatted subtotal value (e.g., “$2,345.67”). | ||
(ALPHA) Row context - value or subtotal row. | |||
number | (ALPHA) Zero-based row position in the | ||
“subtotalValue” | (ALPHA) Discriminator literal for narrowing the | ||
(ALPHA) Raw aggregated subtotal value from the backend. Result of summing/averaging/etc. across sibling rows or columns. |
Property details
ITableSubtotalMeasureValue.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 or subtotal column.
columnDefinition: ITableValueColumnDefinition | ITableSubtotalColumnDefinition;
ITableSubtotalMeasureValue.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.
columnIndex: number;
ITableSubtotalMeasureValue.formattedValuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Human-readable formatted subtotal value (e.g., “$2,345.67”).
formattedValue: string | null;
ITableSubtotalMeasureValue.rowDefinitionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Row context - value or subtotal row.
rowDefinition: ITableValueRowDefinition | ITableSubtotalRowDefinition;
ITableSubtotalMeasureValue.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.
rowIndex: number;
ITableSubtotalMeasureValue.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: "subtotalValue";
ITableSubtotalMeasureValue.valuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Raw aggregated subtotal value from the backend. Result of summing/averaging/etc. across sibling rows or columns.
value: DataValue;