Skip to main content Skip to complementary content
Qlik Resources

NxDimensionInfo

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.

Information note 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 String
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 NxStateCounts
qTags

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

 Array of String
qError 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

Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

Formatting mechanism

The formatting mechanism depends on the type set in qType, as shown below:

Information note

In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

Type is DATE, TIME, TIMESTAMP or INTERVAL

The following applies:

  • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
  • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
  • The properties qDec , qThou , qnDec , qUseThou are not used.

Type is INTEGER

The following applies:

  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
  • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

Type is REAL

The following applies:

  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
  • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
  • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
  • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is FIX

The following applies:

  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
  • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is MONEY

The following applies:

  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
  • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

Type is ASCII

No formatting, qFmt is ignored.

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

Minimum value.

 Number (double)
qMax

Maximum value.

 Number (double)
qContinuousAxes

Is continuous axis used.

 Boolean
qIsCyclic

Is a cyclic dimension used.

 Boolean
qDerivedField

Is derived field is used as a dimension.

 Boolean
qAttrExprInfo

Array of attribute expressions.

 Array of NxAttrExprInfo
qAttrDimInfo

Array 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 NxCardinalities
qLibraryId

Refers to a dimension stored in the library.

 String

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here