NxTreeDimensionInfo

    Stability index

    EXPERIMENTAL.
    This API is under development. Do not rely on it. It may change or be removed in future versions.

    Properties

    Name Description Type
    qFallbackTitle

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

    		 String
    qApprMaxGlyphCount

    Length of the longest value in the field.

    		 Integer
    qCardinal

    Number of distinct field values.

    DEPRECATED.
    This is deprecated and may be removed in a future version.
    		Integer
    qLocked

    Is set to true if the field is locked.

    		 Boolean
    qSortIndicator

    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
    		 String
    qGroupFallbackTitles

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

    		 Array of Strings
    qGroupPos

    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.

    		 Integer
    qStateCounts

    Number of values in a particular state.

    		 NxStateCounts
    qTags

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

    		 Array of Strings
    qError

    This parameter is optional. Gives information on the error.

    		 NxValidationError
    qDimensionType

    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
    		 String
    qReverseSort

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

    		 Boolean
    qGrouping

    Defines the grouping.

    One of:

    • N or GRP_NX_NONE
    • H or GRP_NX_HIEARCHY
    • C or GRP_NX_COLLECTION
    		 String
    qIsSemantic

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

    		 Boolean
    qNumFormat

    Format of the field. This parameter is optional.

    		 FieldAttributes
    qIsAutoFormat

    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.

    		 Boolean
    qGroupFieldDefs

    Array of field names.

    		 Array of Strings
    qMin

    Minimum value.

    		 Double
    qMax

    Maximum value.

    		 Double
    qContinuousAxes

    Is continuous axis used.

    		 Boolean
    qIsCyclic

    Is a cyclic dimension used.

    		 Boolean
    qDerivedField

    Is derived field is used as a dimension.

    		 Boolean
    qMeasureInfo

    A List of measures to be calculated on this TreeDimension.

    		 Array of NxMeasureInfo
    qAttrExprInfo

    List of attribute expressions.

    		 Array of NxAttrExprInfo
    qAttrDimInfo

    List of attribute dimensions.

    		 Array of NxAttrDimInfo
    qCalcCondMsg

    The message displayed if calculation condition is not fulfilled.

    		 String
    qIsCalculated

    True if this is a calculated dimension.

    		 Boolean
    qIsOneAndOnlyOne

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

    		 Boolean
    qCardinalities

    Dimension Cardinalities

    		 NxCardinalities
    qLibraryId

    Refers to a dimension stored in the library.

    		 String