ITableAttributeColumnDefinition
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
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 |
export interface ITableAttributeColumnDefinition
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) Metadata about this attribute (name, data type, formatting, etc.). Contains information like the attribute’s display name, local identifier, etc. | |||
number | (ALPHA) Position of this column in the final table (0-based). | ||
number | (ALPHA) Which attribute from the rows bucket this column represents (0-based). | ||
“attribute” | (ALPHA) Always “attribute” - identifies this as an attribute column. |
Property details
ITableAttributeColumnDefinition.attributeDescriptorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Metadata about this attribute (name, data type, formatting, etc.). Contains information like the attribute’s display name, local identifier, etc.
attributeDescriptor: IAttributeDescriptor;
ITableAttributeColumnDefinition.columnIndexpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Position of this column in the final table (0-based).
columnIndex: number;
ITableAttributeColumnDefinition.rowHeaderIndexpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Which attribute from the rows bucket this column represents (0-based).
rowHeaderIndex: number;
ITableAttributeColumnDefinition.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Always “attribute” - identifies this as an attribute column.
type: "attribute";