ITableGrandTotalMeasureValue · GoodData.UI API reference

Home > @gooddata/sdk-ui > ITableGrandTotalMeasureValue

ITableGrandTotalMeasureValue 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 **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

Signature:

export interface ITableGrandTotalMeasureValue

Properties

Property	Type	Description
columnDefinition	ITableValueColumnDefinition \| ITableGrandTotalColumnDefinition \| ITableMeasureGroupValueColumnDefinition	*(ALPHA)* Column context - value column, grand-total column, or measure group value column.
columnIndex	number	*(ALPHA)* Zero-based column position in the `data` matrix.
formattedValue	string \| null	*(ALPHA)* Human-readable formatted grand total value (e.g., "$10,000.00"). Uses the measure's format string and locale settings.
rowDefinition	ITableValueRowDefinition \| ITableGrandTotalRowDefinition	*(ALPHA)* Row context - value or grand-total row.
rowIndex	number	*(ALPHA)* Zero-based row position in the `data` matrix.
type	"grandTotalValue"	*(ALPHA)* Discriminator literal for narrowing the `ITableDataValue` union.
value	DataValue	*(ALPHA)* Raw aggregated grand total value from the backend. Result of aggregating across all rows or columns for this measure.