ITableAttributeHeaderValue · GoodData.UI API reference

Home > @gooddata/sdk-ui > ITableAttributeHeaderValue

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

Cell located in ITableAttributeColumnDefinition – typically the leftmost part of the table describing the current row's attribute values.

It represents a single IResultAttributeHeader coming from the execution response and can be present in both value rows and subtotal rows.

**Visual example**

 Attribute | Measure |
-----------+---------+
 USA       |  100    | <- "USA" is attributeHeader

Signature:

export interface ITableAttributeHeaderValue

Properties

Property	Type	Description
columnDefinition	ITableAttributeColumnDefinition	*(ALPHA)* Full column context describing which attribute column this cell belongs to. Always an attribute column since this interface is for attribute headers.
columnIndex	number	*(ALPHA)* Zero-based column position of this cell in the final `data` matrix.
formattedValue	string \| null	*(ALPHA)* Attribute element value ready to be rendered. (e.g. "United States")
rowDefinition	ITableValueRowDefinition \| ITableSubtotalRowDefinition	*(ALPHA)* Full row context describing which row this cell belongs to (value, subtotal, or grand-total row).
rowIndex	number	*(ALPHA)* Zero-based row position of this cell in the final `data` matrix.
type	"attributeHeader"	*(ALPHA)* Discriminator literal for narrowing the `ITableDataValue` union.
value	IResultAttributeHeader	*(ALPHA)* The raw `IResultAttributeHeader` object from the execution response.