ITableTotalHeaderValue

Home > @gooddata/sdk-ui > ITableTotalHeaderValue

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

Cell that represents total header. Each cell corresponds to one IResultTotalHeader and labels the total for that specific row / column.

**Visual example**

 Attribute | Value |
-----------+-------+
 USA       |  100  |
 Sum A     |   80  | <- "Sum A" is totalHeader

Signature:

export interface ITableTotalHeaderValue 

Properties

Property	Modifiers	Type	Description
columnDefinition		ITableValueColumnDefinition | ITableSubtotalColumnDefinition | ITableMeasureGroupHeaderColumnDefinition | ITableAttributeColumnDefinition	(ALPHA) Column context - value column, subtotal column, measure group header column, or attribute column.
columnIndex		number	(ALPHA) Zero-based column position in the data matrix. Points to the measure header column when measures are transposed.
formattedValue		string | null	(ALPHA) Display text for the total header (e.g., "Sum", "Avg", "Max").
rowDefinition		ITableValueRowDefinition | ITableSubtotalRowDefinition	(ALPHA) Row context - subtotal or value row.
rowIndex		number	(ALPHA) Zero-based row position in the data matrix. Usually points to a subtotal or grand-total row.
type		"totalHeader"	(ALPHA) Discriminator literal for narrowing the ITableDataValue union.
value		IResultTotalHeader	(ALPHA) The raw IResultTotalHeader object containing total metadata like totalType, measureIndex, etc.