Type Alias NxTreeDimensionInfo

type NxTreeDimensionInfo = {
    qApprMaxGlyphCount?: number;
    qAttrDimInfo?: NxAttrDimInfo[];
    qAttrExprInfo?: NxAttrExprInfo[];
    qCalcCondMsg?: string;
    qCardinal?: number;
    qCardinalities?: NxCardinalities;
    qContinuousAxes?: boolean;
    qDerivedField?: boolean;
    qDimensionType?: NxDimensionType;
    qEffectiveDimensionName?: string;
    qError?: NxValidationError;
    qFallbackTitle?: string;
    qGroupFallbackTitles?: string[];
    qGroupFieldDefs?: string[];
    qGrouping?: NxGrpType;
    qGroupPos?: number;
    qIsAutoFormat?: boolean;
    qIsCalculated?: boolean;
    qIsCyclic?: boolean;
    qIsOneAndOnlyOne?: boolean;
    qIsSemantic?: boolean;
    qLibraryId?: string;
    qLocked?: boolean;
    qMax?: number;
    qMeasureInfo?: NxMeasureInfo[];
    qMin?: number;
    qNumFormat?: FieldAttributes;
    qReverseSort?: boolean;
    qSortIndicator?: NxSortIndicatorType;
    qStateCounts?: NxStateCounts;
    qTags?: string[];
}
Index

Properties

qApprMaxGlyphCount? qAttrDimInfo? qAttrExprInfo? qCalcCondMsg? qCardinal? qCardinalities? qContinuousAxes? qDerivedField? qDimensionType? qEffectiveDimensionName? qError? qFallbackTitle? qGroupFallbackTitles? qGroupFieldDefs? qGrouping? qGroupPos? qIsAutoFormat? qIsCalculated? qIsCyclic? qIsOneAndOnlyOne? qIsSemantic? qLibraryId? qLocked? qMax? qMeasureInfo? qMin? qNumFormat? qReverseSort? qSortIndicator? qStateCounts? qTags?

Properties

qApprMaxGlyphCount?: number

Length of the longest value in the field.

qAttrDimInfo?: NxAttrDimInfo[]

List of attribute dimensions.

qAttrExprInfo?: NxAttrExprInfo[]

List of attribute expressions.

qCalcCondMsg?: string

The message displayed if calculation condition is not fulfilled.

qCardinal?: number

Number of distinct field values.

@deprecated: This will be removed in a future version

qCardinalities?: NxCardinalities

Dimension Cardinalities

qContinuousAxes?: boolean

Is continuous axis used.

qDerivedField?: boolean

Is derived field is used as a dimension.

qDimensionType?: NxDimensionType

Binary format of the field.

One of:

  • D or NX_DIMENSION_TYPE_DISCRETE
  • N or NX_DIMENSION_TYPE_NUMERIC
  • T or NX_DIMENSION_TYPE_TIME
qEffectiveDimensionName?: string

The expanded and stripped dimension name used internally in engine.

Stability: experimental

qError?: NxValidationError

This parameter is optional. Gives information on the error.

qFallbackTitle?: string

Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used.

qGroupFallbackTitles?: string[]

Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group).

qGroupFieldDefs?: string[]

Array of field names.

qGrouping?: NxGrpType

Defines the grouping.

One of:

  • N or GRP_NX_NONE
  • H or GRP_NX_HIEARCHY
  • C or GRP_NX_COLLECTION
qGroupPos?: number

Index of the dimension that is currently in use. qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups.

qIsAutoFormat?: boolean

This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition.

qIsCalculated?: boolean

True if this is a calculated dimension.

qIsCyclic?: boolean

Is a cyclic dimension used.

qIsOneAndOnlyOne?: boolean

If set to true, it means that the field always has one and only one selected value.

qIsSemantic?: boolean

If set to true, it means that the field is a semantic.

qLibraryId?: string

Refers to a dimension stored in the library.

qLocked?: boolean

Is set to true if the field is locked.

qMax?: number

Maximum value.

qMeasureInfo?: NxMeasureInfo[]

A List of measures to be calculated on this TreeDimension.

qMin?: number

Minimum value.

qNumFormat?: FieldAttributes

Format of the field. This parameter is optional.

qReverseSort?: boolean

If set to true, it inverts the sort criteria in the field.

qSortIndicator?: NxSortIndicatorType

Sort indicator. The default value is no sorting. This parameter is optional.

One of:

  • N or NX_SORT_INDICATE_NONE
  • A or NX_SORT_INDICATE_ASC
  • D or NX_SORT_INDICATE_DESC
qStateCounts?: NxStateCounts

Number of values in a particular state.

qTags?: string[]

Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII

Settings

Member Visibility

On This Page

Properties