ITableColumnDefinition
Home > @gooddata/sdk-ui > ITableColumnDefinition
ITableColumnDefinition 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.
Represents all possible column types in a pivot table structure.
Think of a pivot table as having these column types from left to right: 1. **Attribute columns** - Show row grouping labels (like "Country", "City") 2. **Measure header column** - Shows measure names (only when measures are in rows) 3. **Value/Total columns** - Show actual numbers and totals
The exact combination depends on your data setup:
**When measures are in columns (normal pivot table):**
| | | Brand > Product | | |
| | |---------------------|----------------|----------------|
| | | GoodData | | ColMin Σ |
| | |---------------------|----------------| |
| | | Panther | Bear | Sum A | |
|---------|--------|---------------------|----------------|----------------|
| Country | City | Sales | Sales | Sales | Sales |
|---------|--------|----------|----------|----------------|----------------|
| USA | NYC | 100 | 150 | 250 | 100 |
| USA | LA | 200 | 250 | 450 | 200 |
- Country, City are ITableAttributeColumnDefinition - Sales is ITableValueColumnDefinition - Sum A is ITableSubtotalColumnDefinition - ColSum Σ is ITableGrandTotalColumnDefinition
**When measures are in rows (transposed + non-pivoted):**
| Country | City | MeasureGroupHeader | MeasureGroupValue |
|---------|------|---------------------|-----------------------|
| USA | NYC | Sales | 100 |
| USA | NYC | Profit | 20 |
- Country, City are ITableAttributeColumnDefinition - MeasureGroupHeader is ITableMeasureGroupHeaderColumnDefinition - MeasureGroupValue is ITableMeasureGroupValueColumnDefinition
**When measures are in rows (transposed + pivoted):**
| | Quarter | |
|----------------------------------------|----------------| |
| Country | City | MeasureGroupHeader | Q1 | ColSum Σ |
|---------|------|-----------------------|----------------|----------------|
| USA | NYC | Sales | 250 | 500 |
| USA | NYC | Profit | 450 | 900 |
- Country, City are ITableAttributeColumnDefinition - MeasureGroupHeader is ITableMeasureGroupHeaderColumnDefinition - Q1 is ITableValueColumnDefinition - ColSum Σ is ITableGrandTotalColumnDefinition
Signature:
export type ITableColumnDefinition = ITableAttributeColumnDefinition | ITableValueColumnDefinition | ITableMeasureGroupHeaderColumnDefinition | ITableMeasureGroupValueColumnDefinition | ITableSubtotalColumnDefinition | ITableGrandTotalColumnDefinition;
References: ITableAttributeColumnDefinition, ITableValueColumnDefinition, ITableMeasureGroupHeaderColumnDefinition, ITableMeasureGroupValueColumnDefinition, ITableSubtotalColumnDefinition, ITableGrandTotalColumnDefinition