ITableMeasureGroupHeaderColumnDefinition

Home > @gooddata/sdk-ui > ITableMeasureGroupHeaderColumnDefinition

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

Defines the column that shows measure names when measures are in rows.

**What it does:** When you put measures in rows instead of columns, you need a column to show which measure each row represents ("Sales", "Profit", etc.).

**When it's created:** - Only when measureDimension === "rows" (measures are transposed) - Always created when you have measures in rows - Appears right after your attribute columns

**Real example:**

| Country | City | Measure | Q1  | Q2  |  <- "Measure" column shows measure names
|---------|------|---------|-----|-----|
| USA     | NYC  | Sales   | 100 | 150 |
| USA     | NYC  | Profit  | 20  | 30  |
| USA     | LA   | Sales   | 200 | 250 |
| USA     | LA   | Profit  | 40  | 50  |

Signature:

export interface ITableMeasureGroupHeaderColumnDefinition

Properties

PropertyModifiersTypeDescription
attributeDescriptorsIAttributeDescriptor[](ALPHA) Descriptors for attributes that are in the columns bucket.
columnIndexnumber(ALPHA) Position of this column in the final table (0-based). Always appears right after attribute columns, before value columns.
measureGroupDescriptorIMeasureGroupDescriptor(ALPHA) Metadata about the group of measures being displayed. Contains information about all measures that will appear in rows.
type"measureGroupHeader"(ALPHA) Always "measureGroupHeader" - identifies this as a measure names column.
← ITableGrandTotalSubtotalMeasureValueITableMeasureGroupValueColumnDefinition →