ITableAttributeColumnDefinition
Home > @gooddata/sdk-ui > ITableAttributeColumnDefinition
ITableAttributeColumnDefinition 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 a column that shows row attribute values (like "Country" or "City").
**What it does:** These are the leftmost columns that show your row groupings. If you have "Country" and "City" in your rows bucket, you'll get two attribute columns.
**When it's created:** - Automatically created for each attribute in the rows bucket - Always appears first (leftmost) in the table - Created regardless of whether you have measures in rows or columns
**Real example:**
| Country | City | Sales | <- "Country" and "City" are attribute columns
|---------|------|-------|
| USA | NYC | 100 |
| USA | LA | 200 |
Signature:
export interface ITableAttributeColumnDefinition
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
attributeDescriptor | IAttributeDescriptor | (ALPHA) Metadata about this attribute (name, data type, formatting, etc.). Contains information like the attribute's display name, local identifier, etc. | |
columnIndex | number | (ALPHA) Position of this column in the final table (0-based). | |
rowHeaderIndex | number | (ALPHA) Which attribute from the rows bucket this column represents (0-based). | |
type | "attribute" | (ALPHA) Always "attribute" - identifies this as an attribute column. |