ITableDataValue
Home > @gooddata/sdk-ui > ITableDataValue
ITableDataValue type
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.
Union of **all possible cell value shapes** that can appear in the table data
matrix. Each variant corresponds to a concrete column × row intersection produced by dataViewToTableData
.
- Header cells (
attributeHeader
,measureHeader
,totalHeader
) - Numeric cells with raw measure data (value
) - Aggregations (subtotalValue
,grandTotalValue
,grandTotalSubtotalValue
,overallTotalValue
)
When interpreting the data
matrix you should always rely on the concrete subtype.
**Example table without transposition:**
Attr A | Col A | Sum A | ColSum Σ |
----------+---------+---------+----------+
Row X | 100 | 200 | 300 |
Sum B | 400 | 600 | 1000 |
RowSum Σ | 500 | 800 | 1300 |
- Attr A is attribute column, Col A is value column, Sum A is subtotal column, ColSum Σ is grand total column - Row X is value row, Sum B is subtotal row, RowSum Σ is grand total row
In this example: - Row X is attributeHeader
- Sum B is totalHeader
- RowSum Σ is grandTotalHeader
- Row X : Col A - 100
is value
- Row X : Sum A - 200
is subtotalValue
- Row X : ColSum Σ - 300
is grandTotalValue
- Sum B : Col A - 400
is subtotalValue
- Sum B : Sum A - 600
is subtotalValue
- Sum B : ColSum Σ - 1000
is grandTotalSubtotalValue
- RowSum Σ : Col A - 500
is grandTotalValue
- RowSum Σ : Sum A - 800
is grandTotalSubtotalValue
- RowSum Σ : ColSum Σ - 1300
is overallTotalValue
Signature:
export type ITableDataValue = ITableAttributeHeaderValue | ITableMeasureHeaderValue | ITableTotalHeaderValue | ITableMeasureValue | ITableSubtotalMeasureValue | ITableGrandTotalHeaderValue | ITableGrandTotalMeasureValue | ITableGrandTotalSubtotalMeasureValue | ITableOverallTotalMeasureValue;
References: ITableAttributeHeaderValue, ITableMeasureHeaderValue, ITableTotalHeaderValue, ITableMeasureValue, ITableSubtotalMeasureValue, ITableGrandTotalHeaderValue, ITableGrandTotalMeasureValue, ITableGrandTotalSubtotalMeasureValue, ITableOverallTotalMeasureValue