ITableSubtotalMeasureValue · GoodData.UI API reference

Home > @gooddata/sdk-ui > ITableSubtotalMeasureValue

ITableSubtotalMeasureValue interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Signature:

export interface ITableSubtotalMeasureValue

Properties

Property	Type	Description
columnDefinition	ITableValueColumnDefinition \| ITableSubtotalColumnDefinition	*(ALPHA)* Column context - value column or subtotal column.
columnIndex	number	*(ALPHA)* Zero-based column position in the `data` matrix.
formattedValue	string \| null	*(ALPHA)* Human-readable formatted subtotal value (e.g., "$2,345.67").
rowDefinition	ITableValueRowDefinition \| ITableSubtotalRowDefinition	*(ALPHA)* Row context - value or subtotal row.
rowIndex	number	*(ALPHA)* Zero-based row position in the `data` matrix.
type	"subtotalValue"	*(ALPHA)* Discriminator literal for narrowing the `ITableDataValue` union.
value	DataValue	*(ALPHA)* Raw aggregated subtotal value from the backend. Result of summing/averaging/etc. across sibling rows or columns.