ITableGrandTotalHeaderValue · GoodData.UI API reference

Home > @gooddata/sdk-ui > ITableGrandTotalHeaderValue

ITableGrandTotalHeaderValue 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.

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

Signature:

export interface ITableGrandTotalHeaderValue

Properties

Property	Type	Description
columnDefinition	ITableAttributeColumnDefinition \| ITableMeasureGroupHeaderColumnDefinition	*(ALPHA)* Column context - typically an attribute column or measure header column where the grand total label appears.
columnIndex	number	*(ALPHA)* Zero-based column position in the `data` matrix. Usually points to the first attribute column (leftmost) or measure header column (when measures are transposed).
formattedValue	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.
rowDefinition	ITableGrandTotalRowDefinition	*(ALPHA)* Row context - grand-total row since this header cell is labeling a grand-total row.
rowIndex	number	*(ALPHA)* Zero-based row position in the `data` matrix. Points to a grand-total row that this header cell labels.
type	"grandTotalHeader"	*(ALPHA)* Discriminator literal for narrowing the `ITableDataValue` union.