Type Alias NxDimension

The fields or expressions in the dimension are either defined in **qDef** or in the master dimension referred to by **qLibraryId**. If **qLibraryId** is set then the qFieldDefs, qFieldLabels, qGrouping, qLabelExpression and qAlias of the master dimension will be used.
If the dimension is set in the hypercube and not in the library, this dimension cannot be shared with other objects.
A dimension that is set in the library can be used by many objects.
type NxDimension = {
    qAttributeDimensions?: NxAttrDimDef[];
    qAttributeExpressions?: NxAttrExprDef[];
    qCalcCond?: ValueExpr;
    qCalcCondition?: NxCalcCond;
    qDef?: NxInlineDimensionDef;
    qIncludeElemValue?: boolean;
    qLibraryId?: string;
    qNullSuppression?: boolean;
    qOtherLabel?: StringExpr;
    qOtherTotalSpec?: OtherTotalSpecProp;
    qShowAll?: boolean;
    qShowTotal?: boolean;
    qTotalLabel?: StringExpr;
}
Index

Properties

qAttributeDimensions?: NxAttrDimDef[]

List of attribute dimensions.

qAttributeExpressions?: NxAttrExprDef[]

List of attribute expressions.

qCalcCond?: ValueExpr

Specifies a calculation condition, which must be fulfilled for the dimension to be calculated. If the calculation condition is not met, the dimension is excluded from the calculation. By default, there is no calculation condition. This property is optional.

qCalcCondition?: NxCalcCond

Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the dimension is excluded from the calculation and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional.

Refers to a dimension stored in the hypercube.

qIncludeElemValue?: boolean
qLibraryId?: string

Refers to a dimension stored in the library.

qNullSuppression?: boolean

If set to true, no null values are returned.

qOtherLabel?: StringExpr

This property is used when some dimension limits are set. Label of the Others group. The default label is Others . Example: "qOtherLabel":"= <label>" or "qOtherLabel":{"qExpr":"= <label>"} Where:

  • < label > is the label of the Others group.
qOtherTotalSpec?: OtherTotalSpecProp

Sets the dimension limits. Each dimension of a hypercube is configured separately. Defines if some values (grouped as Others ) should be grouped together in the visualization. For example in a pie chart all values lower than 200 could be grouped together.

qShowAll?: boolean

If set to true, all dimension values are shown.

qShowTotal?: boolean
qTotalLabel?: StringExpr

If this property is set, the total of the calculated values is returned. The default label is Total . Example: "qTotalLabel":"= <label>" or "qTotalLabel":{"qExpr":"= <label>"} Where:

  • < label > is the label of the Total group.