IDimensionDescriptor

Home > @gooddata/sdk-model > IDimensionDescriptor

IDimensionDescriptor interface

Dimension descriptor is the output counter-part of the dimension specification that was included in the execution definition.

Signature:

export interface IDimensionDescriptor

Remarks

It describes in further detail the LDM objects which were used to obtain data and metadata for the dimension in the cross-tabulated result.

The information is provided in a form of attribute or measure group descriptors. The contract is that the descriptors appear in the same order as they were specified in the execution definition.

This best best demonstrated using examples.

  1. Execution was done for attribute A1 and measures M1 and M2. Both attribute and measureGroup are in single dimension.

The result dimension will contain two headers, first will be header describing the attribute IAttributeDescriptor, followed by IMeasureGroupDescriptor. The measure group header contains two items - one for each requested measure.

  1. Execution was done for attributes A1 and A2, measures M1 and M2. Attribute A1 is in first dimension and the remainder of objects (A2 and measureGroup) is in second dimension.

There will be two result dimension descriptors. First descriptor will specify single header for A1 attribute, second descriptor will have two headers, first will be header for attribute A2 and then measure group header with two items.

Properties

PropertyModifiersTypeDescription
headersIDimensionItemDescriptor[]
← IDimensionIDimensionItemDescriptor →