ITableDataHeaderScope

Home > @gooddata/sdk-ui > ITableDataHeaderScope

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

Union of all possible scope types that identify what a specific row or column represents.

**Think of scopes as the "address" system for table data:** - Each row has a rowScope: ITableDataHeaderScope[] array - Each column has a columnScope: ITableDataHeaderScope[] array - These arrays describe the "path" to identify exactly what data belongs in each cell

When all scopes are regular scopes (attributes and measures) it represents value column or value row. When scopes are mixed regular and total scopes, it represents subtotal column or subtotal row. When all scopes are total scopes it represents grand total column or grand total row.

Signature:

export type ITableDataHeaderScope = ITableDataAttributeScope | ITableDataAttributeTotalScope | ITableDataMeasureScope | ITableDataMeasureTotalScope | ITableDataMeasureGroupScope;

References: ITableDataAttributeScope, ITableDataAttributeTotalScope, ITableDataMeasureScope, ITableDataMeasureTotalScope, ITableDataMeasureGroupScope