Qlik Sense Engine (qix)

Download OpenRPC spec
schemas

schemas AlfaNumString object

Deprecated

Properties

  • qString string

    Calculated value.

  • qIsNum boolean

    Is set to true if the value is a numeric.

schemas AlternateStateData object

Properties

  • qStateName string

    Name of the alternate state. Default is current selections: $

  • qFieldItems array of objects

    List of the selections.

    Show qFieldItems properties
    • qDef object
      Show qDef properties
      • qName string

        Name of the field.

      • qType string

        Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

    • qLocked boolean

      Indicates if the field is locked. Default is false.

    • qSelectInfo object
      Show qSelectInfo properties
      • qTextSearch string

        Text search string. Everything that matches the text is selected. This parameter is optional.

      • qRangeLo number

        Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

        default = -1e+300, format = double, default = -1e+300

      • qRangeHi number

        Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

        default = -1e+300, format = double, default = -1e+300

      • qNumberFormat object

        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:

        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.

        Show qNumberFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRangeInfo array of objects

        This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

        Show qRangeInfo properties
        • qRangeLo number

          Lowest value in the range.

          default = -1e+300, format = double, default = -1e+300

        • qRangeHi number

          Highest value in the range.

          default = -1e+300, format = double, default = -1e+300

        • qMeasure string

          Label of the measure.
      • qSoftLock boolean

        Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

        default = false

      • qContinuousRangeInfo array of objects

        List of information about ranges for selections.

        Show qContinuousRangeInfo properties
        • qMin number

          Lowest value in the range

          format = double

        • qMax number

          Highest value in the range

          format = double

        • qMinInclEq boolean

          If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

        • qMaxInclEq boolean

          If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
      • qSelectFieldSearch boolean

        This parameter is true if the TextSearch is a result of a Select Field operation.

        default = false

    • qValues array of objects
      Show qValues properties
      • qText string

        Text related to the field value. This parameter is optional.

      • qIsNumeric boolean

        Is set to true if the value is a numeric. This parameter is optional. Default is false.

      • qNumber number

        Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

        format = double

    • qExcludedValues array of objects

      List of excluded values. Either the list of selected values or the list of excluded values is displayed.

      Show qExcludedValues properties
      • qText string

        Text related to the field value. This parameter is optional.

      • qIsNumeric boolean

        Is set to true if the value is a numeric. This parameter is optional. Default is false.

      • qNumber number

        Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

        format = double

    • qAndMode boolean

      If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

    • qOneAndOnlyOne boolean

      If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

    • qValuesCount integer

      Count of selected values. Indicates if the Values field is loaded.

      default = -1, format = int32, default = -1

    • qExcludedValuesCount integer

      Count of excluded values. Indicates if the ExcludedValues field is loaded.

      default = -1, format = int32, default = -1

schemas AppEntry object

Properties

  • qID string

    Identifier of the app.

  • qTitle string

    Title of the app.

  • qPath string

    Path of the app.

  • qLastReloadTime string

    Last reload time of the app.

  • qReadOnly boolean

    Is set to true if the app is read-only.

  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qThumbnail object
    In addition, this structure can return dynamic properties.
    Show qThumbnail properties
    • qUrl string

      Relative path of the thumbnail.
  • qFileSize integer

    format = int64

  • qHasSectionAccess boolean

    If true the app has section access configured.

schemas AppObjectList object

Lists the app objects. Is the layout for AppObjectListDef.

An app object is a generic object created at app level.

Properties

  • qItems array of objects

    Information about the list of dimensions.

    Show qItems properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.
    • qData object

      Contains dynamic JSON data specified by the client.

schemas AppObjectListDef object

Defines the list of objects in an app.

An app object is a generic object created at app level.

Properties

  • qType string

    Type of the app list.

  • qData object

    Contains dynamic JSON data specified by the client.

schemas AppScript object

Properties

  • qScript string

    Script text.

  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qIsLocked boolean

    When true, the user is temporarily locked from modifying the script. The Meta information contains the ID of the last modifier. Only applicable to Qlik Cloud.

schemas AppScriptMeta object

Experimental

Properties

  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qIsLocked boolean

    When true, the user is temporarily locked from modifying the script. The Meta information contains the ID of the last modifier. Only applicable to Qlik Cloud.

schemas ApplyGroupStateWarning object

Experimental

Properties

  • qState object
    Experimental
    Show qState properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qActiveFieldDef string

      String defining the active field.
  • qType string

    Can be one of: "group_missing""group_not_applicable""fielddef_missing"

schemas ApplyGroupStateWarningType string

oneOf

  • group_missing

    GROUP_MISSING

  • group_not_applicable

    GROUP_NOT_APPLICABLE

  • fielddef_missing

    FIELDDEF_MISSING

schemas ApplyGroupStatesResult object

Experimental

Result of applying GroupState to multiple cyclic groups.

Properties

  • qApplySuccess boolean

    When true, the operation was successful.

  • qWarnings array of objects
    Experimental

    Lists which states failed to be applied and why.

    Show qWarnings properties
    • qState object
      Experimental
      Show qState properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qActiveFieldDef string

        String defining the active field.
    • qType string

      Can be one of: "group_missing""group_not_applicable""fielddef_missing"

schemas ArrayOfNxValuePoint object[]

Element properties

  • qLabel string

    Label of the cell. This parameter is optional.

  • qText string

    Some text related to the cell.

  • qNum number

    Value of the cell.

    format = double

  • qType string

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDims object
    Show qAttrDims properties
    • qValues array of objects

      List of values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNo integer

        Element number.

        format = int32

schemas AssociationScore object

Properties

  • qFieldPairName string

    Pair of fields. < FieldName1> / < FieldName2> Where: < FieldName1 > is a field in the table 1 (defined in qTable1 ) < FieldName2 > is a field in the table 2 (defined in qTable2 ) If the field is a synthetic key, the name of the field is preceded by [Synthetic key]: .

  • qScoreSummary integer

    Flag used to interpret calculated scores. One of the following values or sum of values that apply:

    • 0: The cardinal ratio cannot be zero but the symbol score and the row score can be zero.
    • -1: The fields do not have the same type.
    • -2: The number of rows of the field FieldName1 is zero.
    • -4: The number of distinct values of the field FieldName1 is zero.
    • -8: The number of rows of the field FieldName2 is zero.
    • -16: The number of distinct values of the field FieldName2 is zero.

    Example: The number of rows of the field FieldName1 is zero, and the number of distinct values of the field FieldName2 is zero, then qScoreSummary is -18.

    format = int32

  • qField1Scores object
    Show qField1Scores properties
    • qFieldName string

      Field name. One of the field names defined in qFieldPairName.

    • qReadableName string
    • qCardinalRatio number

      Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key.

      format = double

    • qSymbolScore number

      Number of distinct matches between the two fields defined in qFieldPairName divided by the number of distinct values in the field qFieldName . If 0, it means that there are no common values between the two fields defined in qFieldPairName .

      format = double

    • qRowScore number

      Number of matches between the two fields defined in qFieldPairName divided by the number of values in the field qFieldName . If 0, it means that there are no common values between the two fields defined in qFieldPairName .

      format = double

  • qField2Scores object
    Show qField2Scores properties
    • qFieldName string

      Field name. One of the field names defined in qFieldPairName.

    • qReadableName string
    • qCardinalRatio number

      Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key.

      format = double

    • qSymbolScore number

      Number of distinct matches between the two fields defined in qFieldPairName divided by the number of distinct values in the field qFieldName . If 0, it means that there are no common values between the two fields defined in qFieldPairName .

      format = double

    • qRowScore number

      Number of matches between the two fields defined in qFieldPairName divided by the number of values in the field qFieldName . If 0, it means that there are no common values between the two fields defined in qFieldPairName .

      format = double

schemas BNFDef object

Properties

  • qBnf array of integers

    Array of token references that all together build up the definition of the current token. Generally, if the array is not empty, the definition is a BNF rule (qIsBnfRule is set to true). However, some BNF  rules do have an empty array (qIsBnfRule is set to true, but qBnf is empty).

  • qNbr integer

    Number of the current token definition.

    format = int32

  • qPNbr integer

    Number of the parent rule definition.

    format = int32

  • qHelpId integer

    Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name. Is not used in Qlik Sense.

    format = int32

  • qName string

    Token name. One of:

    • A rule name
    • An identifier
    • A literal value
  • qStr string

    Literal string of the token. Examples: 'Round' and '('.

  • qIsBnfRule boolean

    If set to true, a list of related rule tokens is assigned to qBnf . This parameter is optional. The default value is false.

    default = false

  • qScriptStatement boolean

    If set to true, the definition specifies a script statement. This parameter is optional. The default value is false.

    default = false

  • qControlStatement boolean

    If set to true, the definition specifies a control statement. This parameter is optional. The default value is false.

    default = false

  • qBnfLiteral boolean

    If set to true, the definition specifies a literal token. This parameter is optional. The default value is false.

    default = false

  • qQvFunc boolean

    If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function. This parameter is optional. The default value is false.

    default = false

  • qAggrFunc boolean

    If set to true, the definition is related to an aggregation function. This parameter is optional. The default value is false.

    default = false

  • qFG string

    Can be one of: "ALL""U""NONE""AGGR""NUM""RNG""EXP""TRIG""FIN""MATH""COUNT""STR""MAPP""RCRD""CND""LOG""NULL""SYS""FILE""TBL""DATE""NUMI""FRMT""CLR""RNK""GEO""EXT""PROB""ARRAY""LEG""DB""WINDOW"

  • qFieldFlag boolean

    If set to true, the definition is related to a field. This parameter is optional. The default value is false.

    default = false

  • qMT string

    Can be one of: "N""D""R""V"

  • qDepr boolean

    Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use). If set to true, the script statement or the function is not recommended for use in Qlik Sense. This parameter is optional. The default value is false.

    default = false

  • qFGList array of strings

    List of groups the function belongs to.

    Values may be any of: "ALL""U""NONE""AGGR""NUM""RNG""EXP""TRIG""FIN""MATH""COUNT""STR""MAPP""RCRD""CND""LOG""NULL""SYS""FILE""TBL""DATE""NUMI""FRMT""CLR""RNK""GEO""EXT""PROB""ARRAY""LEG""DB""WINDOW"

schemas BNFDefMetaType string

oneOf

  • N

    NOT_META

  • D

    META_DOC_NAME

  • R

    META_RET_TYPE

  • V

    META_DEFAULT_VALUE

schemas BNFType string

oneOf

  • S

    SCRIPT_TEXT_SCRIPT

  • E

    SCRIPT_TEXT_EXPRESSION

schemas Blob string

schemas Bookmark object

Properties

  • qId string
  • qName string
  • qUtcModifyTime number

    format = double

  • qUtcRecallTime number

    format = double

  • qRecallCount integer

    format = int32

  • qApplyAdditive boolean
  • qFieldItems array of objects
    Show qFieldItems properties
    • qDef object
      Show qDef properties
      • qName string

        Name of the field.

      • qType string

        Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

    • qLocked boolean

      Indicates if the field is locked. Default is false.

    • qSelectInfo object
      Show qSelectInfo properties
      • qTextSearch string

        Text search string. Everything that matches the text is selected. This parameter is optional.

      • qRangeLo number

        Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

        default = -1e+300, format = double, default = -1e+300

      • qRangeHi number

        Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

        default = -1e+300, format = double, default = -1e+300

      • qNumberFormat object

        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:

        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.

        Show qNumberFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRangeInfo array of objects

        This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

        Show qRangeInfo properties
        • qRangeLo number

          Lowest value in the range.

          default = -1e+300, format = double, default = -1e+300

        • qRangeHi number

          Highest value in the range.

          default = -1e+300, format = double, default = -1e+300

        • qMeasure string

          Label of the measure.
      • qSoftLock boolean

        Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

        default = false

      • qContinuousRangeInfo array of objects

        List of information about ranges for selections.

        Show qContinuousRangeInfo properties
        • qMin number

          Lowest value in the range

          format = double

        • qMax number

          Highest value in the range

          format = double

        • qMinInclEq boolean

          If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

        • qMaxInclEq boolean

          If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
      • qSelectFieldSearch boolean

        This parameter is true if the TextSearch is a result of a Select Field operation.

        default = false

    • qValues array of objects
      Show qValues properties
      • qText string

        Text related to the field value. This parameter is optional.

      • qIsNumeric boolean

        Is set to true if the value is a numeric. This parameter is optional. Default is false.

      • qNumber number

        Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

        format = double

    • qExcludedValues array of objects

      List of excluded values. Either the list of selected values or the list of excluded values is displayed.

      Show qExcludedValues properties
      • qText string

        Text related to the field value. This parameter is optional.

      • qIsNumeric boolean

        Is set to true if the value is a numeric. This parameter is optional. Default is false.

      • qNumber number

        Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

        format = double

    • qAndMode boolean

      If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

    • qOneAndOnlyOne boolean

      If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

    • qValuesCount integer

      Count of selected values. Indicates if the Values field is loaded.

      default = -1, format = int32, default = -1

    • qExcludedValuesCount integer

      Count of excluded values. Indicates if the ExcludedValues field is loaded.

      default = -1, format = int32, default = -1

  • qVariableItems array of objects
    Show qVariableItems properties
    • qName string

      Name of the variable.

    • qValue object
      Show qValue properties
      • qText string

        Text related to the field value. This parameter is optional.

      • qIsNumeric boolean

        Is set to true if the value is a numeric. This parameter is optional. Default is false.

      • qNumber number

        Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

        format = double

    • qDefinition string

      The Reporting mode definition of the variable.
  • qSheetId string
  • qObjects array of objects
    Show qObjects properties
    • qId string
    • qActive boolean
    • qShowMode integer

      format = byte

    • qScrollPos object
      Show qScrollPos properties
      • qUsePosition boolean
      • qPos object
        Show qPos properties
        • qx integer

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qy integer

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

  • qApplyLayoutState boolean

    default = false

  • qShowPopupInfo boolean

    default = false

  • qInfoText string
  • qOwner string
  • qGroups array of objects
    Show qGroups properties
    • qId string
    • qCyclePos integer

      format = int32

  • qShow object
    Show qShow properties
    • qAlways boolean

      default = true

    • qExpression object
      Show qExpression properties
      • qv string

        Expression evaluated to dual.
  • qApplyInputFieldValues boolean

    default = true

  • qInputFieldItems array of objects
    Show qInputFieldItems properties
    • qFieldName string
    • qValues array of objects
      Show qValues properties
      • qText string

        Text related to the field value. This parameter is optional.

      • qIsNumeric boolean

        Is set to true if the value is a numeric. This parameter is optional. Default is false.

      • qNumber number

        Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

        format = double

    • qPackedHashKeys array of integers
  • qObjectsLayout array of objects
    Show qObjectsLayout properties
    • qId string
    • qActive boolean
    • qShowMode integer

      format = byte

    • qScrollPos object
      Show qScrollPos properties
      • qUsePosition boolean
      • qPos object
        Show qPos properties
        • qx integer

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qy integer

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

    • qExpansionInfo array of objects
      Show qExpansionInfo properties
      • qExcludeList boolean
      • qPos object
        Show qPos properties
        • qDimName string
        • qElemNo array of integers
        • qElemValues array of strings
    • qLeftCollapsed boolean
    • qTopCollapsed boolean
    • qSortData array of objects
      Show qSortData properties
      • qName string
      • qReversed boolean
    • qDimensionGroupPos array of objects
      Show qDimensionGroupPos properties
      • qGroupName string
      • qCurrentItemName string
    • qExpressionGroupPos array of objects
      Show qExpressionGroupPos properties
      • qGroupName string
      • qCurrentItemName string
    • qUseGraphMode boolean
    • qGraphMode string

      Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"

    • qActiveContainerChildObjectId string
    • qExtendedPivotState object
      Show qExtendedPivotState properties
      • qExpressionPosition integer

        format = byte

      • qNumberOfLeftDimensions integer

        format = byte

      • qDimensionNames array of strings
      • qEnableConditions array of strings
  • qIncludeSelectionState boolean

    default = true

  • qIncludeScrollPosition boolean
  • qAlternateStateData array of objects
    Show qAlternateStateData properties
    • qStateName string

      Name of the alternate state. Default is current selections: $

    • qFieldItems array of objects

      List of the selections.

      Show qFieldItems properties
      • qDef object
        Show qDef properties
        • qName string

          Name of the field.

        • qType string

          Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

      • qLocked boolean

        Indicates if the field is locked. Default is false.

      • qSelectInfo object
        Show qSelectInfo properties
        • qTextSearch string

          Text search string. Everything that matches the text is selected. This parameter is optional.

        • qRangeLo number

          Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

          default = -1e+300, format = double, default = -1e+300

        • qRangeHi number

          Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

          default = -1e+300, format = double, default = -1e+300

        • qNumberFormat object

          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:

          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.

          Show qNumberFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRangeInfo array of objects

          This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

          Show qRangeInfo properties
          • qRangeLo number

            Lowest value in the range.

            default = -1e+300, format = double, default = -1e+300

          • qRangeHi number

            Highest value in the range.

            default = -1e+300, format = double, default = -1e+300

          • qMeasure string

            Label of the measure.
        • qSoftLock boolean

          Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

          default = false

        • qContinuousRangeInfo array of objects

          List of information about ranges for selections.

          Show qContinuousRangeInfo properties
          • qMin number

            Lowest value in the range

            format = double

          • qMax number

            Highest value in the range

            format = double

          • qMinInclEq boolean

            If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

          • qMaxInclEq boolean

            If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
        • qSelectFieldSearch boolean

          This parameter is true if the TextSearch is a result of a Select Field operation.

          default = false

      • qValues array of objects
        Show qValues properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qExcludedValues array of objects

        List of excluded values. Either the list of selected values or the list of excluded values is displayed.

        Show qExcludedValues properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qAndMode boolean

        If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

      • qOneAndOnlyOne boolean

        If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

      • qValuesCount integer

        Count of selected values. Indicates if the Values field is loaded.

        default = -1, format = int32, default = -1

      • qExcludedValuesCount integer

        Count of excluded values. Indicates if the ExcludedValues field is loaded.

        default = -1, format = int32, default = -1

  • qForAnnotations boolean
  • qIncludeAllVariables boolean

    default = false

schemas BookmarkApplyAndVerifyResult object

Experimental

Properties

  • qApplySuccess boolean

    Apply successfully or not *

  • qWarnings array of objects
    Experimental

    Field values verfication result *

    Show qWarnings properties
    • qState string

      Alternate State *

    • qField string

      Field Name *

    • qVerifyResult string

      Can be one of: "NOT_VERIFIED""FIELD_VALUE_MATCH_ALL""FIELD_MISSING""FIELD_VALUE_MISSING""STATE_MISSING""SEARCH_NO_MATCH"

    • qMissingValues array of strings Deprecated

      Strings representing missing field values. Will be replaced by MissingDuals. *

    • qMissingDuals array of objects
      Experimental

      Missing field values as duals, carrying both text and numeric parts. Number of values included is capped. Default cap is 20. *

      Show qMissingDuals properties
      • qText string

        Text related to the field value. This parameter is optional.

      • qIsNumeric boolean

        Is set to true if the value is a numeric. This parameter is optional. Default is false.

      • qNumber number

        Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

        format = double

    • qTotalMissing integer
      Experimental

      Total count of missing field values *

      format = int32

  • qGroupStateResult object
    Experimental

    Result of applying GroupState to multiple cyclic groups.

    Show qGroupStateResult properties
    • qApplySuccess boolean

      When true, the operation was successful.

    • qWarnings array of objects
      Experimental

      Lists which states failed to be applied and why.

      Show qWarnings properties
      • qState object
        Experimental
        Show qState properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qActiveFieldDef string

          String defining the active field.
      • qType string

        Can be one of: "group_missing""group_not_applicable""fielddef_missing"

schemas BookmarkFieldItem object

Properties

  • qDef object
    Show qDef properties
    • qName string

      Name of the field.

    • qType string

      Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

  • qLocked boolean

    Indicates if the field is locked. Default is false.

  • qSelectInfo object
    Show qSelectInfo properties
    • qTextSearch string

      Text search string. Everything that matches the text is selected. This parameter is optional.

    • qRangeLo number

      Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

      default = -1e+300, format = double, default = -1e+300

    • qRangeHi number

      Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

      default = -1e+300, format = double, default = -1e+300

    • qNumberFormat object

      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:

      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.

      Show qNumberFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qRangeInfo array of objects

      This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

      Show qRangeInfo properties
      • qRangeLo number

        Lowest value in the range.

        default = -1e+300, format = double, default = -1e+300

      • qRangeHi number

        Highest value in the range.

        default = -1e+300, format = double, default = -1e+300

      • qMeasure string

        Label of the measure.
    • qSoftLock boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

      default = false

    • qContinuousRangeInfo array of objects

      List of information about ranges for selections.

      Show qContinuousRangeInfo properties
      • qMin number

        Lowest value in the range

        format = double

      • qMax number

        Highest value in the range

        format = double

      • qMinInclEq boolean

        If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

      • qMaxInclEq boolean

        If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
    • qSelectFieldSearch boolean

      This parameter is true if the TextSearch is a result of a Select Field operation.

      default = false

  • qValues array of objects
    Show qValues properties
    • qText string

      Text related to the field value. This parameter is optional.

    • qIsNumeric boolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumber number

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

  • qExcludedValues array of objects

    List of excluded values. Either the list of selected values or the list of excluded values is displayed.

    Show qExcludedValues properties
    • qText string

      Text related to the field value. This parameter is optional.

    • qIsNumeric boolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumber number

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

  • qAndMode boolean

    If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

  • qOneAndOnlyOne boolean

    If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

  • qValuesCount integer

    Count of selected values. Indicates if the Values field is loaded.

    default = -1, format = int32, default = -1

  • qExcludedValuesCount integer

    Count of excluded values. Indicates if the ExcludedValues field is loaded.

    default = -1, format = int32, default = -1

schemas BookmarkFieldPage object

Defines the range of the bookmark fields that are returned.

Properties

  • qStartIndex integer

    The start value of the range.

    format = int32

  • qEndIndex integer

    The end value of the range.

    format = int32

schemas BookmarkFieldPageEx object

Properties

  • qStateName string

    The name of the selected state.

    default = "$"

  • qStartIndex integer

    The start value of the range.

    default = 0, format = int32, default = 0

  • qEndIndex integer

    The end value of the range.

    default = 0, format = int32, default = 0

schemas BookmarkFieldVerifyResultState string

oneOf

  • NOT_VERIFIED

  • FIELD_VALUE_MATCH_ALL

  • FIELD_MISSING

  • FIELD_VALUE_MISSING

  • STATE_MISSING

  • SEARCH_NO_MATCH

schemas BookmarkFieldVerifyWarning object

Experimental

Properties

  • qState string

    Alternate State *

  • qField string

    Field Name *

  • qVerifyResult string

    Can be one of: "NOT_VERIFIED""FIELD_VALUE_MATCH_ALL""FIELD_MISSING""FIELD_VALUE_MISSING""STATE_MISSING""SEARCH_NO_MATCH"

  • qMissingValues array of strings Deprecated

    Strings representing missing field values. Will be replaced by MissingDuals. *

  • qMissingDuals array of objects
    Experimental

    Missing field values as duals, carrying both text and numeric parts. Number of values included is capped. Default cap is 20. *

    Show qMissingDuals properties
    • qText string

      Text related to the field value. This parameter is optional.

    • qIsNumeric boolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumber number

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

  • qTotalMissing integer
    Experimental

    Total count of missing field values *

    format = int32

schemas BookmarkList object

Lists the bookmarks. Is the layout for BookmarkListDef.

Properties

  • qItems array of objects

    Information about the list of bookmarks.

    Show qItems properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.
    • qData object

      Contains dynamic JSON data specified by the client.

schemas BookmarkListDef object

Defines the list of bookmarks.

Properties

  • qType string

    Type of the list.

  • qData object

    Contains dynamic JSON data specified by the client.

  • qIncludePatches boolean

    Include the bookmark patches. Patches can be very large and may make the list result unmanageable.

schemas BookmarkStateFieldPages object

Properties

  • qStatePages array of objects

    Bookmark field pages for different states.

    Show qStatePages properties
    • qStateName string

      The name of the selected state.

      default = "$"

    • qStartIndex integer

      The start value of the range.

      default = 0, format = int32, default = 0

    • qEndIndex integer

      The end value of the range.

      default = 0, format = int32, default = 0

schemas BookmarkVariableItem object

Properties

  • qName string

    Name of the variable.

  • qValue object
    Show qValue properties
    • qText string

      Text related to the field value. This parameter is optional.

    • qIsNumeric boolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumber number

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

  • qDefinition string

    The Reporting mode definition of the variable.

schemas CalendarStrings object

Properties

  • qDayNames array of strings

    List of short day names.

  • qMonthNames array of strings

    List of short month names.

  • qLongDayNames array of strings

    List of long day names.

  • qLongMonthNames array of strings

    List of long month names.

schemas CharEncodingType string

oneOf

  • Utf8

    CHAR_ENCODING_UTF8

  • Utf16

    CHAR_ENCODING_UTF16

schemas CharRange object

Properties

  • qCharPos integer

    Position of the first search occurrence.

    format = int32

  • qCharCount integer

    Number of occurrences found.

    format = int32

schemas ChildList object

Lists the children of a generic object. Is the layout for ChildListDef.

ChildList is used by the _GetLayout Method_ to list the children of a generic object.

Properties

  • qItems array of objects

    Information about the items in the app object.

    Show qItems properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.
    • qData object

      Contains dynamic JSON data specified by the client.

schemas ChildListDef object

Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

Properties

  • qData object

    Contains dynamic JSON data specified by the client.

schemas CodePage object

Properties

  • qNumber integer

    Number of the code page.

    format = int32

  • qName string

    Name of the code page.

  • qDescription string

    Description of the code page.

schemas CondDef object

Properties

  • qAlways boolean

    default = true

  • qExpression object
    Show qExpression properties
    • qv string

      Expression evaluated to dual.

schemas Connection object

Properties

  • qId string

    Identifier of the connection. Is generated by the engine and is unique.

  • qName string

    Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection.

  • qConnectionString string

    One of:

    • ODBC CONNECT TO [<provider name>]
    • OLEDB CONNECT TO [<provider name>]
    • CUSTOM CONNECT TO [<provider name>]
    • "<local absolute or relative path, UNC path>"
    • "<URL>"

    Connection string. This parameter is mandatory and must be set when creating or modifying a connection.

  • qType string

    One of:

    • ODBC
    • OLEDB
    • <Name of the custom connection file>
    • folder
    • internet

    Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive.

  • qUserName string

    Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the user name.

  • qPassword string

    Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the password.

  • qModifiedDate string

    Is generated by the engine. Creation date of the connection or last modification date of the connection.

  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qLogOn string

    Can be one of: "LOG_ON_SERVICE_USER""LOG_ON_CURRENT_USER"

schemas ContentLibraryList object

Properties

  • qItems array of objects

    Information about the content library.

    Show qItems properties
    • qName string

      Name of the library.

    • qAppSpecific boolean

      Is set to true if the library is specific to the app (not a global content library).

    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.

schemas ContentLibraryListItem object

Properties

  • qName string

    Name of the library.

  • qAppSpecific boolean

    Is set to true if the library is specific to the app (not a global content library).

  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.

schemas CustomConnector object

Properties

  • qProvider string

    Name of the custom connector file.

  • qParent string

    Name of the parent folder that contains the custom connector file.

  • qDisplayName string

    Name of the custom connector as displayed in the Qlik interface.

  • qMachineMode string

    Can be one of: "CONNECT_DEFAULT""CONNECT_64""CONNECT_32"

  • qSupportFileStreaming boolean

schemas CyclicGroupPosition object

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qActiveField integer

    Active field of the cyclic group, identified by a zero-based index.

    format = int32

schemas DataField object

Properties

  • qName string

    Name of the field.

  • qIsKey boolean

    Is set to true if the field is a primary key.

    default = false

  • qOriginalFieldName string

    Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file.

schemas DataRecord object

Properties

  • qValues array of strings

    List of values inside the table. The first values (in result/qPreview/0/qValues ) correspond to the field names in the table. The following values (from result/qPreview/1/qValues ) are the values of the fields in the table.

schemas DataTable object

Properties

  • qName string

    Name of the table.

  • qType string

    Type of the table. For example: Table or View.

  • qLogicalName string

    Logical name of the table. Used by nested Parquet tables.

schemas DataTableEx object

Properties

  • qName string

    Name of the table.

  • qFields array of objects

    List of the fields in the table.

    Show qFields properties
    • qName string

      Name of the field.

    • qIsKey boolean

      Is set to true if the field is a primary key.

      default = false

    • qOriginalFieldName string

      Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file.
  • qFormatSpec string

    List of format specification items, within brackets. Examples of specification items:

    • file type
    • embedded labels, no labels
    • table is <table name>
  • qLogicalName string

    Logical name of the table. Used by nested Parquet tables.

schemas Database object

Properties

  • qName string

    Name of the database.

  • qIsDefault boolean

    Is set to true if the database is set by default.

schemas DatabaseInfo object

Properties

  • qDBMSName string

    Name of the product accessed by the provider.

  • qDBUsage boolean

    If set to true, it means that the data source contains some databases.

  • qOwnerUsage boolean

    If set to true, it means that the data source contains some owners.

  • qDBSeparator string

    Character string used after the database name. Example with separator " . ": FROM LinkedTablesData.dbo.Months Where:

    • LinkedTablesData is the database name
    • dbo is the owner name
    • Months is the table name
  • qOwnerSeparator string

    Character string used after the owner name. Example with separator " . ": FROM LinkedTablesData.dbo.Months Where:

    • LinkedTablesData is the database name
    • dbo is the owner name
    • Months is the table name
  • qDBFirst boolean

    If set to true, it means that the database is displayed first, before the owners and tables.

  • qQuotePreffix string

    Prefix used with field, database or owner names that contain special characters or keywords.

  • qQuoteSuffix string

    Suffix used with field, database or owner names that contain special characters or keywords.

  • qSpecialChars string

    List of the special characters.

  • qDefaultDatabase string

    Name of the default database.

  • qKeywords array of strings

    List of the script keywords.

schemas DatabaseOwner object

Properties

  • qName string

    Name of the owner.

schemas DelimiterInfo object

Properties

  • qName string

    Name of the delimiter. Example: "Tab_DELIMITER"

  • qScriptCode string

    Representation of the delimiter value that is used in the script. Example: "'\t'"

  • qNumber integer

    Delimiter character number used by the engine to determine how to separate the values.

    format = int32

  • qIsMultiple boolean

    Is set to true if multiple spaces are used to separate the values.

schemas DerivedFieldsInTableData object

Properties

  • qDefinitionName string

    Name of the derived definition.

  • qTags array of strings

    List of tags.

  • qActive boolean

    Is set to true is the derived field is in use.

schemas DimensionList object

Lists the dimensions. Is the layout for DimensionListDef.

Properties

  • qItems array of objects

    Information about the list of dimensions.

    Show qItems properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.
    • qData object

      Contains dynamic JSON data specified by the client.

schemas DimensionListDef object

Defines the lists of dimensions.

Properties

  • qType string

    Type of the list.

  • qData object

    Contains dynamic JSON data specified by the client.

schemas DimensionReference object

Experimental

The DimensionReference structure points to a GenericDimension.

Properties

  • qId string

    Identifier of the associated dimension.

  • qLabel string

    Text label.

schemas DoReloadExParams object

Parameters for a reload.

Properties

  • qMode integer
    1. : for default mode.
    2. : for ABEND; the reload of the script ends if an error occurs.
    3. : for ignore; the reload of the script continues even if an error is detected in the script.

    default = 0, format = int32, default = 0

  • qPartial boolean

    Set to true for partial reload. The default value is false.

    default = false

  • qDebug boolean

    Set to true to debug reload. The default value is false.

    default = false

  • qReloadId string

    Optional reload ID. ID will be automatically generated if not set.

  • qSkipStore boolean

    When true, Store statements are skipped. The default value is false.

    default = false

  • qRowLimit integer

    If greater than or equal to 0, defines the maximum number of rows loaded from a data source.

    default = -1, format = int64, default = -1

schemas DoReloadExResult object

The result and path to script log for a reload.

Properties

  • qSuccess boolean

    The reload is successful if True.

  • qScriptLogFile string

    Path to the script log file.

  • qEndedWithMemoryConstraint boolean

    true if memory limits were exhausted during reload.

  • qNbrOfLoadedRows integer

    Number of read rows during a reload

    format = int64

  • qNbrOfStoredRows integer

    Number of stored rows from a reload

    format = int64

  • qFailureData object
    Show qFailureData properties
    • qErrors array of objects

      Array of errors accumulated during reload.

      Show qErrors properties
      • qError string

        Type of error.

      • qDescription string

        Description of error.

      • qLine string

        Script line text where error occurred.

      • qLineNumber integer

        Script line number where error occurred (zero-based).

        format = int32

      • qCode integer

        Error code.

        format = int32

      • qTitle string

        Can be one of: "LOCERR_INTERNAL_ERROR""LOCERR_GENERIC_UNKNOWN""LOCERR_GENERIC_OK""LOCERR_GENERIC_NOT_SET""LOCERR_GENERIC_NOT_FOUND""LOCERR_GENERIC_ALREADY_EXISTS""LOCERR_GENERIC_INVALID_PATH""LOCERR_GENERIC_ACCESS_DENIED""LOCERR_GENERIC_OUT_OF_MEMORY""LOCERR_GENERIC_NOT_INITIALIZED""LOCERR_GENERIC_INVALID_PARAMETERS""LOCERR_GENERIC_EMPTY_PARAMETERS""LOCERR_GENERIC_INTERNAL_ERROR""LOCERR_GENERIC_CORRUPT_DATA""LOCERR_GENERIC_MEMORY_INCONSISTENCY""LOCERR_GENERIC_INVISIBLE_OWNER_ABORT""LOCERR_GENERIC_PROHIBIT_VALIDATE""LOCERR_GENERIC_ABORTED""LOCERR_GENERIC_CONNECTION_LOST""LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION""LOCERR_GENERIC_REST_CONNECTION_FAILURE""LOCERR_GENERIC_MEMORY_LIMIT_REACHED""LOCERR_GENERIC_NOT_IMPLEMENTED""LOCERR_GENERIC_ENGINE_TERMINATED""LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED""LOCERR_HTTP_400""LOCERR_HTTP_401""LOCERR_HTTP_402""LOCERR_HTTP_403""LOCERR_HTTP_404""LOCERR_HTTP_405""LOCERR_HTTP_406""LOCERR_HTTP_407""LOCERR_HTTP_408""LOCERR_HTTP_409""LOCERR_HTTP_410""LOCERR_HTTP_411""LOCERR_HTTP_412""LOCERR_HTTP_413""LOCERR_HTTP_414""LOCERR_HTTP_415""LOCERR_HTTP_416""LOCERR_HTTP_417""LOCERR_HTTP_422""LOCERR_HTTP_423""LOCERR_HTTP_429""LOCERR_HTTP_500""LOCERR_HTTP_501""LOCERR_HTTP_502""LOCERR_HTTP_503""LOCERR_HTTP_504""LOCERR_HTTP_505""LOCERR_HTTP_509""LOCERR_HTTP_COULD_NOT_RESOLVE_HOST""LOCERR_APP_ALREADY_EXISTS""LOCERR_APP_INVALID_NAME""LOCERR_APP_ALREADY_OPEN""LOCERR_APP_NOT_FOUND""LOCERR_APP_IMPORT_FAILED""LOCERR_APP_SAVE_FAILED""LOCERR_APP_CREATE_FAILED""LOCERR_APP_INVALID""LOCERR_APP_CONNECT_FAILED""LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE""LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE""LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION""LOCERR_APP_MIGRATION_FAILURE""LOCERR_APP_SCRIPT_MISSING""LOCERR_APP_EXPORT_FAILED""LOCERR_APP_SIZE_EXCEEDED""LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED""LOCERR_APP_NOT_OPEN""LOCERR_APP_EVENT_SOURCE_TIMEOUT""LOCERR_APP_SOFT_DELETED""LOCERR_CONNECTION_ALREADY_EXISTS""LOCERR_CONNECTION_NOT_FOUND""LOCERR_CONNECTION_FAILED_TO_LOAD""LOCERR_CONNECTION_FAILED_TO_IMPORT""LOCERR_CONNECTION_NAME_IS_INVALID""LOCERR_CONNECTION_MISSING_CREDENTIALS""LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT""LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE""LOCERR_FILE_ACCESS_DENIED""LOCERR_FILE_NAME_INVALID""LOCERR_FILE_CORRUPT""LOCERR_FILE_NOT_FOUND""LOCERR_FILE_FORMAT_UNSUPPORTED""LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE""LOCERR_FILE_TABLE_NOT_FOUND""LOCERR_USER_ACCESS_DENIED""LOCERR_USER_IMPERSONATION_FAILED""LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS""LOCERR_SERVER_OUT_OF_SESSION_CALS""LOCERR_SERVER_OUT_OF_USAGE_CALS""LOCERR_SERVER_OUT_OF_CALS""LOCERR_SERVER_OUT_OF_NAMED_CALS""LOCERR_SERVER_OFF_DUTY""LOCERR_SERVER_BUSY""LOCERR_SERVER_LICENSE_EXPIRED""LOCERR_SERVER_AJAX_DISABLED""LOCERR_SERVER_NO_TOKEN""LOCERR_HC_INVALID_OBJECT""LOCERR_HC_RESULT_TOO_LARGE""LOCERR_HC_INVALID_OBJECT_STATE""LOCERR_HC_MODAL_OBJECT_ERROR""LOCERR_CALC_INVALID_DEF""LOCERR_CALC_NOT_IN_LIB""LOCERR_CALC_HEAP_ERROR""LOCERR_CALC_TOO_LARGE""LOCERR_CALC_TIMEOUT""LOCERR_CALC_EVAL_CONDITION_FAILED""LOCERR_CALC_MIXED_LINKED_AGGREGATION""LOCERR_CALC_MISSING_LINKED""LOCERR_CALC_INVALID_COL_SORT""LOCERR_CALC_PAGES_TOO_LARGE""LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED""LOCERR_CALC_VALIDATION_STATE_INVALID""LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS""LOCERR_CALC_MISSING_LINKED_FIELD""LOCERR_CALC_NOT_CALCULATED""LOCERR_LAYOUT_EXTENDS_INVALID_ID""LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND""LOCERR_LAYOUT_LINKED_OBJECT_INVALID""LOCERR_PERSISTENCE_WRITE_FAILED""LOCERR_PERSISTENCE_READ_FAILED""LOCERR_PERSISTENCE_DELETE_FAILED""LOCERR_PERSISTENCE_NOT_FOUND""LOCERR_PERSISTENCE_UNSUPPORTED_VERSION""LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY""LOCERR_PERSISTENCE_MIGRATION_CANCELLED""LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED""LOCERR_PERSISTENCE_DISK_FULL""LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP""LOCERR_PERSISTENCE_MOVE_FAILED""LOCERR_PERSISTENCE_OBJECT_LOCKED""LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING""LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS""LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS""LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED""LOCERR_RELOAD_IN_PROGRESS""LOCERR_RELOAD_TABLE_X_NOT_FOUND""LOCERR_RELOAD_UNKNOWN_STATEMENT""LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_FIELD_X_NOT_FOUND""LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND""LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND""LOCERR_RELOAD_NAME_ALREADY_TAKEN""LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF""LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF""LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED""LOCERR_RELOAD_OPEN_FILE_ERROR""LOCERR_RELOAD_AUTO_GENERATE_COUNT""LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB""LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR""LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND""LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID""LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE""LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE""LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS""LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS""LOCERR_RELOAD_NO_OPEN_DATABASE""LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY""LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE""LOCERR_RELOAD_ODBC_CONNECT_FAILED""LOCERR_RELOAD_OLEDB_CONNECT_FAILED""LOCERR_RELOAD_CUSTOM_CONNECT_FAILED""LOCERR_RELOAD_ODBC_READ_FAILED""LOCERR_RELOAD_OLEDB_READ_FAILED""LOCERR_RELOAD_CUSTOM_READ_FAILED""LOCERR_RELOAD_BINARY_LOAD_PROHIBITED""LOCERR_RELOAD_CONNECTOR_START_FAILED""LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING""LOCERR_RELOAD_CONNECTOR_REPLY_ERROR""LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR""LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR""LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS""LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE""LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD""LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT""LOCERR_RELOAD_EXIT_ERROR""LOCERR_PERSONAL_NEW_VERSION_AVAILABLE""LOCERR_PERSONAL_VERSION_EXPIRED""LOCERR_PERSONAL_SECTION_ACCESS_DETECTED""LOCERR_PERSONAL_APP_DELETION_FAILED""LOCERR_USER_AUTHENTICATION_FAILURE""LOCERR_EXPORT_OUT_OF_MEMORY""LOCERR_EXPORT_NO_DATA""LOCERR_SYNC_INVALID_OFFSET""LOCERR_SEARCH_TIMEOUT""LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL""LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW""LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT""LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED""LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED""LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED""LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED""LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED""LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED""LOCERR_SMART_LOAD_TABLE_NOT_FOUND""LOCERR_SMART_LOAD_TABLE_DUPLICATED""LOCERR_VARIABLE_NO_NAME""LOCERR_VARIABLE_DUPLICATE_NAME""LOCERR_VARIABLE_INCONSISTENCY""LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY""LOCERR_VARIABLE_CONSTRAINT_FAILED""LOCERR_MEDIA_LIBRARY_LIST_FAILED""LOCERR_MEDIA_LIBRARY_CONTENT_FAILED""LOCERR_MEDIA_BUNDLING_FAILED""LOCERR_MEDIA_UNBUNDLING_FAILED""LOCERR_MEDIA_LIBRARY_NOT_FOUND""LOCERR_FEATURE_DISABLED""LOCERR_LOAD_TOO_MANY_FIELDS""LOCERR_LOAD_TOO_MANY_TABLES""LOCERR_JSON_RPC_INVALID_REQUEST""LOCERR_JSON_RPC_METHOD_NOT_FOUND""LOCERR_JSON_RPC_INVALID_PARAMETERS""LOCERR_JSON_RPC_INTERNAL_ERROR""LOCERR_JSON_RPC_RESPONSE_TOO_LARGE""LOCERR_JSON_RPC_PARSE_ERROR""LOCERR_MQ_SOCKET_CONNECT_FAILURE""LOCERR_MQ_SOCKET_OPEN_FAILURE""LOCERR_MQ_PROTOCOL_NO_RESPONE""LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION""LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED""LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED""LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR""LOCERR_MQ_PROTOCOL_INVALID_STATUS""LOCERR_EXTENGINE_GRPC_STATUS_OK""LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED""LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN""LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT""LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED""LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND""LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS""LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED""LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED""LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION""LOCERR_EXTENGINE_GRPC_STATUS_ABORTED""LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE""LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED""LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL""LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE""LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS""LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED""LOCERR_LXW_INVALID_OBJ""LOCERR_LXW_INVALID_FILE""LOCERR_LXW_INVALID_SHEET""LOCERR_LXW_INVALID_EXPORT_RANGE""LOCERR_LXW_ERROR""LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED""LOCERR_LXW_ERROR_CREATING_XLSX_FILE""LOCERR_LXW_ERROR_CREATING_TMPFILE""LOCERR_LXW_ERROR_ZIP_FILE_OPERATION""LOCERR_LXW_ERROR_ZIP_FILE_ADD""LOCERR_LXW_ERROR_ZIP_CLOSE""LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED""LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED""LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED""LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND""LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE""LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED""LOCERR_BDI_STATUS_OK""LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED""LOCERR_TRENDLINE_INVALID_DEF""LOCERR_TRENDLINE_INVALID_MATH_ERROR""LOCERR_CURL_UNSUPPORTED_PROTOCOL""LOCERR_CURL_COULDNT_RESOLVE_PROXY""LOCERR_CURL_COULDNT_CONNECT""LOCERR_CURL_REMOTE_ACCESS_DENIED""LOCERR_CURL_FTP_ACCEPT_FAILED""LOCERR_CURL_FTP_ACCEPT_TIMEOUT""LOCERR_CURL_FTP_CANT_GET_HOST""LOCERR_CURL_PARTIAL_FILE""LOCERR_CURL_QUOTE_ERROR""LOCERR_CURL_WRITE_ERROR""LOCERR_CURL_UPLOAD_FAILED""LOCERR_CURL_OUT_OF_MEMORY""LOCERR_CURL_OPERATION_TIMEDOUT""LOCERR_CURL_FTP_COULDNT_USE_REST""LOCERR_CURL_HTTP_POST_ERROR""LOCERR_CURL_SSL_CONNECT_ERROR""LOCERR_CURL_FILE_COULDNT_READ_FILE""LOCERR_CURL_LDAP_CANNOT_BIND""LOCERR_CURL_LDAP_SEARCH_FAILED""LOCERR_CURL_TOO_MANY_REDIRECTS""LOCERR_CURL_PEER_FAILED_VERIFICATION""LOCERR_CURL_GOT_NOTHING""LOCERR_CURL_SSL_ENGINE_NOTFOUND""LOCERR_CURL_SSL_ENGINE_SETFAILED""LOCERR_CURL_SSL_CERTPROBLEM""LOCERR_CURL_SSL_CIPHER""LOCERR_CURL_SSL_CACERT""LOCERR_CURL_BAD_CONTENT_ENCODING""LOCERR_CURL_LDAP_INVALID_URL""LOCERR_CURL_USE_SSL_FAILED""LOCERR_CURL_SSL_ENGINE_INITFAILED""LOCERR_CURL_LOGIN_DENIED""LOCERR_CURL_TFTP_NOTFOUND""LOCERR_CURL_TFTP_ILLEGAL""LOCERR_CURL_SSH""LOCERR_SETEXPRESSION_TOO_LARGE""LOCERR_RELOAD_MERGE_LOAD_ERROR""LOCERR_WIN_FTP_DROPPED""LOCERR_WIN_FTP_NO_PASSIVE_MODE""LOCERR_WIN_HTTP_DOWNLEVEL_SERVER""LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE""LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION""LOCERR_WIN_INTERNET_FORCE_RETRY""LOCERR_WIN_INTERNET_CANNOT_CONNECT""LOCERR_WIN_INTERNET_CONNECTION_ABORTED""LOCERR_WIN_INTERNET_CONNECTION_RESET""LOCERR_WIN_INTERNET_DISCONNECTED""LOCERR_WIN_INTERNET_INCORRECT_FORMAT""LOCERR_WIN_INTERNET_INVALID_CA""LOCERR_WIN_INTERNET_INVALID_OPERATION""LOCERR_WIN_INTERNET_INVALID_URL""LOCERR_WIN_INTERNET_ITEM_NOT_FOUND""LOCERR_WIN_INTERNET_LOGIN_FAILURE""LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED""LOCERR_WIN_INTERNET_NEED_UI""LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID""LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID""LOCERR_WIN_INTERNET_SEC_CERT_ERRORS""LOCERR_WIN_INTERNET_SEC_INVALID_CERT""LOCERR_WIN_INTERNET_SERVER_UNREACHABLE""LOCERR_BM_RESULT_TOO_LARGE"

schemas DocListEntry object

Properties

  • qDocName string

    Name of the app.

  • qConnectedUsers integer

    Not used.

    format = int32

  • qFileTime number

    Last modified time stamp of the app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise.

    format = double

  • qFileSize number

    Size of remote app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise.

    format = double

  • qDocId string

    Identifier of the app.

    • In Qlik Sense Desktop, the identifier is the path and name of the app.
    • In Qlik Sense Enterprise, the identifier is the app's GUID.
  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qLastReloadTime string

    Last reload time of the app.

  • qReadOnly boolean

    If set to true, the app is read-only.

  • qTitle string

    Title of the app.

  • qThumbnail object
    In addition, this structure can return dynamic properties.
    Show qThumbnail properties
    • qUrl string

      Relative path of the thumbnail.
  • qHasSectionAccess boolean

    If true the app has section access configured.

  • qIsDirectQueryMode boolean

    Is the app a Direct Query app?

  • qUsage string

    Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"

schemas DriveInfo object

Properties

  • qDrive string

    Value of the drive. Examples: C:\, E:\\

  • qType string

    Type of the drive. Fixed means physical drive.

  • qName string

    Name of the drive.

  • qTypeIdentifier string

    Can be one of: "REMOVABLE""FIXED""NETWORK""CD_ROM""RAM""UNKNOWN_TYPE"

  • qUnnamedDrive boolean

schemas DriveType string

oneOf

  • REMOVABLE

  • FIXED

  • NETWORK

  • CD_ROM

  • RAM

  • UNKNOWN_TYPE

schemas EditorBreakpoint object

Properties

  • qbufferName string

    Name of the breakpoint.

  • qlineIx integer

    Line number in the script where the breakpoint is set.

    format = int32

  • qEnabled boolean

    If set to true then the breakpoint is enabled (in use).

schemas EmbeddedSnapshot object

Renders the embedded snapshot in an object. The following is returned:

  • Any dynamic properties defined in the bookmark
  • Any properties defined in qEmbeddedSnapshot

Properties

"qEmbeddedSnapshot": {}

schemas EmbeddedSnapshotDef object

Defines the embedded snapshot in a generic object.

Properties

"EmbeddedSnapshotDef": {}

schemas ErrorData object

Properties

  • qErrorString string

    Detailed information about the error message.

  • qLineEnd string

    Line termination characters.

  • qLine string

    Script statement where the error occurs.

  • qErrorDataCode string

    Can be one of: "EDC_ERROR""EDC_WARNING""EDC_CIRCULAR_REFERENCE"

  • qMessage object
    Show qMessage properties
    • qMessageCode integer

      Code number to the corresponding localized message string.

      format = int32

    • qMessageParameters array of strings

      Parameters to be inserted in the localized message string.

schemas ErrorDataCode string

oneOf

  • EDC_ERROR

  • EDC_WARNING

  • EDC_CIRCULAR_REFERENCE

schemas ExpansionData object

Properties

  • qExcludeList boolean
  • qPos object
    Show qPos properties
    • qDimName string
    • qElemNo array of integers
    • qElemValues array of strings

schemas ExtendedLayoutBookmarkData object

Properties

  • qId string
  • qActive boolean
  • qShowMode integer

    format = byte

  • qScrollPos object
    Show qScrollPos properties
    • qUsePosition boolean
    • qPos object
      Show qPos properties
      • qx integer

        x-coordinate in pixels. The origin is the top left of the screen.

        format = int32

      • qy integer

        y-coordinate in pixels. The origin is the top left of the screen.

        format = int32

  • qExpansionInfo array of objects
    Show qExpansionInfo properties
    • qExcludeList boolean
    • qPos object
      Show qPos properties
      • qDimName string
      • qElemNo array of integers
      • qElemValues array of strings
  • qLeftCollapsed boolean
  • qTopCollapsed boolean
  • qSortData array of objects
    Show qSortData properties
    • qName string
    • qReversed boolean
  • qDimensionGroupPos array of objects
    Show qDimensionGroupPos properties
    • qGroupName string
    • qCurrentItemName string
  • qExpressionGroupPos array of objects
    Show qExpressionGroupPos properties
    • qGroupName string
    • qCurrentItemName string
  • qUseGraphMode boolean
  • qGraphMode string

    Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"

  • qActiveContainerChildObjectId string
  • qExtendedPivotState object
    Show qExtendedPivotState properties
    • qExpressionPosition integer

      format = byte

    • qNumberOfLeftDimensions integer

      format = byte

    • qDimensionNames array of strings
    • qEnableConditions array of strings

schemas ExtendedPivotStateData object

Properties

  • qExpressionPosition integer

    format = byte

  • qNumberOfLeftDimensions integer

    format = byte

  • qDimensionNames array of strings
  • qEnableConditions array of strings

schemas ExtensionList object

Obsolete, use qrs API's to fetch extensions.

Properties

  • qItems array of strings

schemas ExtensionListDef object

Obsolete, use qrs API's to fetch extensions.

schemas FailureData object

Properties

  • qErrors array of objects

    Array of errors accumulated during reload.

    Show qErrors properties
    • qError string

      Type of error.

    • qDescription string

      Description of error.

    • qLine string

      Script line text where error occurred.

    • qLineNumber integer

      Script line number where error occurred (zero-based).

      format = int32

    • qCode integer

      Error code.

      format = int32

    • qTitle string

      Can be one of: "LOCERR_INTERNAL_ERROR""LOCERR_GENERIC_UNKNOWN""LOCERR_GENERIC_OK""LOCERR_GENERIC_NOT_SET""LOCERR_GENERIC_NOT_FOUND""LOCERR_GENERIC_ALREADY_EXISTS""LOCERR_GENERIC_INVALID_PATH""LOCERR_GENERIC_ACCESS_DENIED""LOCERR_GENERIC_OUT_OF_MEMORY""LOCERR_GENERIC_NOT_INITIALIZED""LOCERR_GENERIC_INVALID_PARAMETERS""LOCERR_GENERIC_EMPTY_PARAMETERS""LOCERR_GENERIC_INTERNAL_ERROR""LOCERR_GENERIC_CORRUPT_DATA""LOCERR_GENERIC_MEMORY_INCONSISTENCY""LOCERR_GENERIC_INVISIBLE_OWNER_ABORT""LOCERR_GENERIC_PROHIBIT_VALIDATE""LOCERR_GENERIC_ABORTED""LOCERR_GENERIC_CONNECTION_LOST""LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION""LOCERR_GENERIC_REST_CONNECTION_FAILURE""LOCERR_GENERIC_MEMORY_LIMIT_REACHED""LOCERR_GENERIC_NOT_IMPLEMENTED""LOCERR_GENERIC_ENGINE_TERMINATED""LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED""LOCERR_HTTP_400""LOCERR_HTTP_401""LOCERR_HTTP_402""LOCERR_HTTP_403""LOCERR_HTTP_404""LOCERR_HTTP_405""LOCERR_HTTP_406""LOCERR_HTTP_407""LOCERR_HTTP_408""LOCERR_HTTP_409""LOCERR_HTTP_410""LOCERR_HTTP_411""LOCERR_HTTP_412""LOCERR_HTTP_413""LOCERR_HTTP_414""LOCERR_HTTP_415""LOCERR_HTTP_416""LOCERR_HTTP_417""LOCERR_HTTP_422""LOCERR_HTTP_423""LOCERR_HTTP_429""LOCERR_HTTP_500""LOCERR_HTTP_501""LOCERR_HTTP_502""LOCERR_HTTP_503""LOCERR_HTTP_504""LOCERR_HTTP_505""LOCERR_HTTP_509""LOCERR_HTTP_COULD_NOT_RESOLVE_HOST""LOCERR_APP_ALREADY_EXISTS""LOCERR_APP_INVALID_NAME""LOCERR_APP_ALREADY_OPEN""LOCERR_APP_NOT_FOUND""LOCERR_APP_IMPORT_FAILED""LOCERR_APP_SAVE_FAILED""LOCERR_APP_CREATE_FAILED""LOCERR_APP_INVALID""LOCERR_APP_CONNECT_FAILED""LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE""LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE""LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION""LOCERR_APP_MIGRATION_FAILURE""LOCERR_APP_SCRIPT_MISSING""LOCERR_APP_EXPORT_FAILED""LOCERR_APP_SIZE_EXCEEDED""LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED""LOCERR_APP_NOT_OPEN""LOCERR_APP_EVENT_SOURCE_TIMEOUT""LOCERR_APP_SOFT_DELETED""LOCERR_CONNECTION_ALREADY_EXISTS""LOCERR_CONNECTION_NOT_FOUND""LOCERR_CONNECTION_FAILED_TO_LOAD""LOCERR_CONNECTION_FAILED_TO_IMPORT""LOCERR_CONNECTION_NAME_IS_INVALID""LOCERR_CONNECTION_MISSING_CREDENTIALS""LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT""LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE""LOCERR_FILE_ACCESS_DENIED""LOCERR_FILE_NAME_INVALID""LOCERR_FILE_CORRUPT""LOCERR_FILE_NOT_FOUND""LOCERR_FILE_FORMAT_UNSUPPORTED""LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE""LOCERR_FILE_TABLE_NOT_FOUND""LOCERR_USER_ACCESS_DENIED""LOCERR_USER_IMPERSONATION_FAILED""LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS""LOCERR_SERVER_OUT_OF_SESSION_CALS""LOCERR_SERVER_OUT_OF_USAGE_CALS""LOCERR_SERVER_OUT_OF_CALS""LOCERR_SERVER_OUT_OF_NAMED_CALS""LOCERR_SERVER_OFF_DUTY""LOCERR_SERVER_BUSY""LOCERR_SERVER_LICENSE_EXPIRED""LOCERR_SERVER_AJAX_DISABLED""LOCERR_SERVER_NO_TOKEN""LOCERR_HC_INVALID_OBJECT""LOCERR_HC_RESULT_TOO_LARGE""LOCERR_HC_INVALID_OBJECT_STATE""LOCERR_HC_MODAL_OBJECT_ERROR""LOCERR_CALC_INVALID_DEF""LOCERR_CALC_NOT_IN_LIB""LOCERR_CALC_HEAP_ERROR""LOCERR_CALC_TOO_LARGE""LOCERR_CALC_TIMEOUT""LOCERR_CALC_EVAL_CONDITION_FAILED""LOCERR_CALC_MIXED_LINKED_AGGREGATION""LOCERR_CALC_MISSING_LINKED""LOCERR_CALC_INVALID_COL_SORT""LOCERR_CALC_PAGES_TOO_LARGE""LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED""LOCERR_CALC_VALIDATION_STATE_INVALID""LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS""LOCERR_CALC_MISSING_LINKED_FIELD""LOCERR_CALC_NOT_CALCULATED""LOCERR_LAYOUT_EXTENDS_INVALID_ID""LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND""LOCERR_LAYOUT_LINKED_OBJECT_INVALID""LOCERR_PERSISTENCE_WRITE_FAILED""LOCERR_PERSISTENCE_READ_FAILED""LOCERR_PERSISTENCE_DELETE_FAILED""LOCERR_PERSISTENCE_NOT_FOUND""LOCERR_PERSISTENCE_UNSUPPORTED_VERSION""LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY""LOCERR_PERSISTENCE_MIGRATION_CANCELLED""LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED""LOCERR_PERSISTENCE_DISK_FULL""LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP""LOCERR_PERSISTENCE_MOVE_FAILED""LOCERR_PERSISTENCE_OBJECT_LOCKED""LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING""LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS""LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS""LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED""LOCERR_RELOAD_IN_PROGRESS""LOCERR_RELOAD_TABLE_X_NOT_FOUND""LOCERR_RELOAD_UNKNOWN_STATEMENT""LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_FIELD_X_NOT_FOUND""LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND""LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND""LOCERR_RELOAD_NAME_ALREADY_TAKEN""LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF""LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF""LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED""LOCERR_RELOAD_OPEN_FILE_ERROR""LOCERR_RELOAD_AUTO_GENERATE_COUNT""LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB""LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR""LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND""LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID""LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE""LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE""LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS""LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS""LOCERR_RELOAD_NO_OPEN_DATABASE""LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY""LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE""LOCERR_RELOAD_ODBC_CONNECT_FAILED""LOCERR_RELOAD_OLEDB_CONNECT_FAILED""LOCERR_RELOAD_CUSTOM_CONNECT_FAILED""LOCERR_RELOAD_ODBC_READ_FAILED""LOCERR_RELOAD_OLEDB_READ_FAILED""LOCERR_RELOAD_CUSTOM_READ_FAILED""LOCERR_RELOAD_BINARY_LOAD_PROHIBITED""LOCERR_RELOAD_CONNECTOR_START_FAILED""LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING""LOCERR_RELOAD_CONNECTOR_REPLY_ERROR""LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR""LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR""LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS""LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE""LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD""LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT""LOCERR_RELOAD_EXIT_ERROR""LOCERR_PERSONAL_NEW_VERSION_AVAILABLE""LOCERR_PERSONAL_VERSION_EXPIRED""LOCERR_PERSONAL_SECTION_ACCESS_DETECTED""LOCERR_PERSONAL_APP_DELETION_FAILED""LOCERR_USER_AUTHENTICATION_FAILURE""LOCERR_EXPORT_OUT_OF_MEMORY""LOCERR_EXPORT_NO_DATA""LOCERR_SYNC_INVALID_OFFSET""LOCERR_SEARCH_TIMEOUT""LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL""LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW""LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT""LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED""LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED""LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED""LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED""LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED""LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED""LOCERR_SMART_LOAD_TABLE_NOT_FOUND""LOCERR_SMART_LOAD_TABLE_DUPLICATED""LOCERR_VARIABLE_NO_NAME""LOCERR_VARIABLE_DUPLICATE_NAME""LOCERR_VARIABLE_INCONSISTENCY""LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY""LOCERR_VARIABLE_CONSTRAINT_FAILED""LOCERR_MEDIA_LIBRARY_LIST_FAILED""LOCERR_MEDIA_LIBRARY_CONTENT_FAILED""LOCERR_MEDIA_BUNDLING_FAILED""LOCERR_MEDIA_UNBUNDLING_FAILED""LOCERR_MEDIA_LIBRARY_NOT_FOUND""LOCERR_FEATURE_DISABLED""LOCERR_LOAD_TOO_MANY_FIELDS""LOCERR_LOAD_TOO_MANY_TABLES""LOCERR_JSON_RPC_INVALID_REQUEST""LOCERR_JSON_RPC_METHOD_NOT_FOUND""LOCERR_JSON_RPC_INVALID_PARAMETERS""LOCERR_JSON_RPC_INTERNAL_ERROR""LOCERR_JSON_RPC_RESPONSE_TOO_LARGE""LOCERR_JSON_RPC_PARSE_ERROR""LOCERR_MQ_SOCKET_CONNECT_FAILURE""LOCERR_MQ_SOCKET_OPEN_FAILURE""LOCERR_MQ_PROTOCOL_NO_RESPONE""LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION""LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED""LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED""LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR""LOCERR_MQ_PROTOCOL_INVALID_STATUS""LOCERR_EXTENGINE_GRPC_STATUS_OK""LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED""LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN""LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT""LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED""LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND""LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS""LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED""LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED""LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION""LOCERR_EXTENGINE_GRPC_STATUS_ABORTED""LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE""LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED""LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL""LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE""LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS""LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED""LOCERR_LXW_INVALID_OBJ""LOCERR_LXW_INVALID_FILE""LOCERR_LXW_INVALID_SHEET""LOCERR_LXW_INVALID_EXPORT_RANGE""LOCERR_LXW_ERROR""LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED""LOCERR_LXW_ERROR_CREATING_XLSX_FILE""LOCERR_LXW_ERROR_CREATING_TMPFILE""LOCERR_LXW_ERROR_ZIP_FILE_OPERATION""LOCERR_LXW_ERROR_ZIP_FILE_ADD""LOCERR_LXW_ERROR_ZIP_CLOSE""LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED""LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED""LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED""LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND""LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE""LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED""LOCERR_BDI_STATUS_OK""LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED""LOCERR_TRENDLINE_INVALID_DEF""LOCERR_TRENDLINE_INVALID_MATH_ERROR""LOCERR_CURL_UNSUPPORTED_PROTOCOL""LOCERR_CURL_COULDNT_RESOLVE_PROXY""LOCERR_CURL_COULDNT_CONNECT""LOCERR_CURL_REMOTE_ACCESS_DENIED""LOCERR_CURL_FTP_ACCEPT_FAILED""LOCERR_CURL_FTP_ACCEPT_TIMEOUT""LOCERR_CURL_FTP_CANT_GET_HOST""LOCERR_CURL_PARTIAL_FILE""LOCERR_CURL_QUOTE_ERROR""LOCERR_CURL_WRITE_ERROR""LOCERR_CURL_UPLOAD_FAILED""LOCERR_CURL_OUT_OF_MEMORY""LOCERR_CURL_OPERATION_TIMEDOUT""LOCERR_CURL_FTP_COULDNT_USE_REST""LOCERR_CURL_HTTP_POST_ERROR""LOCERR_CURL_SSL_CONNECT_ERROR""LOCERR_CURL_FILE_COULDNT_READ_FILE""LOCERR_CURL_LDAP_CANNOT_BIND""LOCERR_CURL_LDAP_SEARCH_FAILED""LOCERR_CURL_TOO_MANY_REDIRECTS""LOCERR_CURL_PEER_FAILED_VERIFICATION""LOCERR_CURL_GOT_NOTHING""LOCERR_CURL_SSL_ENGINE_NOTFOUND""LOCERR_CURL_SSL_ENGINE_SETFAILED""LOCERR_CURL_SSL_CERTPROBLEM""LOCERR_CURL_SSL_CIPHER""LOCERR_CURL_SSL_CACERT""LOCERR_CURL_BAD_CONTENT_ENCODING""LOCERR_CURL_LDAP_INVALID_URL""LOCERR_CURL_USE_SSL_FAILED""LOCERR_CURL_SSL_ENGINE_INITFAILED""LOCERR_CURL_LOGIN_DENIED""LOCERR_CURL_TFTP_NOTFOUND""LOCERR_CURL_TFTP_ILLEGAL""LOCERR_CURL_SSH""LOCERR_SETEXPRESSION_TOO_LARGE""LOCERR_RELOAD_MERGE_LOAD_ERROR""LOCERR_WIN_FTP_DROPPED""LOCERR_WIN_FTP_NO_PASSIVE_MODE""LOCERR_WIN_HTTP_DOWNLEVEL_SERVER""LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE""LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION""LOCERR_WIN_INTERNET_FORCE_RETRY""LOCERR_WIN_INTERNET_CANNOT_CONNECT""LOCERR_WIN_INTERNET_CONNECTION_ABORTED""LOCERR_WIN_INTERNET_CONNECTION_RESET""LOCERR_WIN_INTERNET_DISCONNECTED""LOCERR_WIN_INTERNET_INCORRECT_FORMAT""LOCERR_WIN_INTERNET_INVALID_CA""LOCERR_WIN_INTERNET_INVALID_OPERATION""LOCERR_WIN_INTERNET_INVALID_URL""LOCERR_WIN_INTERNET_ITEM_NOT_FOUND""LOCERR_WIN_INTERNET_LOGIN_FAILURE""LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED""LOCERR_WIN_INTERNET_NEED_UI""LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID""LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID""LOCERR_WIN_INTERNET_SEC_CERT_ERRORS""LOCERR_WIN_INTERNET_SEC_INVALID_CERT""LOCERR_WIN_INTERNET_SERVER_UNREACHABLE""LOCERR_BM_RESULT_TOO_LARGE"

schemas FieldAttrType string

oneOf

  • U

    UNKNOWN

  • A

    ASCII

  • I

    INTEGER

  • R

    REAL

  • F

    FIX

  • M

    MONEY

  • D

    DATE

  • T

    TIME

  • TS

    TIMESTAMP

  • IV

    INTERVAL

schemas FieldAttributes object

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:

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.

Properties

  • qType string

    Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

  • qnDec integer

    Number of decimals. Default is 10.

    default = 10, format = int32, default = 10

  • qUseThou integer

    Defines whether or not a thousands separator must be used. Default is 0.

    default = 0, format = int32, default = 0

  • qFmt string

    Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

  • qDec string

    Defines the decimal separator. Example: .

  • qThou string

    Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,

schemas FieldDefEx object

Properties

  • qName string

    Name of the field.

  • qType string

    Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

schemas FieldDescription object

Properties

  • qInternalNumber integer

    Internal number of the field.

    format = int32

  • qName string

    Name of the field.

  • qSrcTables array of strings

    List of table names.

  • qIsSystem boolean

    If set to true, it means that the field is a system field. The default value is false.

  • qIsHidden boolean

    If set to true, it means that the field is hidden. The default value is false.

  • qIsSemantic boolean

    If set to true, it means that the field is a semantic. The default value is false.

  • qDistinctOnly boolean

    If set to true, only distinct field values are shown. The default value is false.

  • qCardinal integer

    Number of distinct field values.

    format = int32

  • qTotalCount integer

    Total number of field values.

    format = int64

  • qPossibleCount_OBSOLETE integer

    format = int32

  • qHasInfo_OBSOLETE boolean
  • qIsLocked boolean

    If set to true, it means that the field is locked. The default value is false.

  • qAlwaysOneSelected boolean

    If set to true, it means that the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false.

  • qAndMode boolean

    If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.

  • qIsNumeric boolean

    Is set to true if the value is a numeric. The default value is false.

  • qComment string

    Field comment.

  • qTags array of strings

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

  • qIsDefinitionOnly boolean

    If set to true, it means that the field is a field on the fly. The default value is false.

  • qByteSize integer

    Static RAM memory used in bytes.

    format = int64

schemas FieldInTableData object

Properties

  • qName string

    Name of the field.

  • qOriginalFields array of strings

    Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file.

  • qPresent boolean
  • qHasNull boolean

    This property is set to true if the field contains some Null values.

  • qHasWild boolean
  • qHasDuplicates boolean

    This property is set to true if the field contains some duplicate values.

  • qIsSynthetic boolean

    This property is set to true if the field contains a synthetic key.

  • qInformationDensity number

    Number of records that have values (for example, not NULL) in the field as compared to the total number of records in the table.

    format = double

  • qnNonNulls integer

    Number of values that are non Null.

    format = int64

  • qnRows integer

    Number of rows in the field.

    format = int64

  • qSubsetRatio number

    Number of distinct values in the field (in the current table) as compared to the total number of distinct values of this field (in all tables).

    format = double

  • qnTotalDistinctValues integer

    Number of distinct values in the field.

    format = int32

  • qnPresentDistinctValues integer

    format = int32

  • qKeyType string

    Can be one of: "NOT_KEY""ANY_KEY""PRIMARY_KEY""PERFECT_KEY"

  • qComment string

    Comment related to the field.

  • qTags array of strings

    List of tags related to the field.

  • qDerivedFields array of objects

    List of the derived fields.

    Show qDerivedFields properties
    • qDefinitionName string

      Name of the derived definition.

    • qTags array of strings

      List of tags.

    • qActive boolean

      Is set to true is the derived field is in use.
  • qIsFieldOnTheFly boolean

    default = false

  • qReadableName string

schemas FieldInTableProfilingData object

Properties

  • qName string

    Name of the field.

  • qFieldTags array of strings

    List of tags related to the field.

  • qNumberFormat object

    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:

    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.

    Show qNumberFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qDistinctValues integer

    Number of distinct values

    format = int64

  • qDistinctNumericValues integer

    Number of distinct numeric values

    format = int64

  • qDistinctTextValues integer

    Number of distinct text values

    format = int64

  • qNumericValues integer

    Number of numeric values

    format = int64

  • qNullValues integer

    Number of null values

    format = int64

  • qTextValues integer

    Number of textual values

    format = int64

  • qNegValues integer

    Number of negative values

    format = int64

  • qPosValues integer

    Number of positive values

    format = int64

  • qZeroValues integer

    Number of zero values for numerical values

    format = int64

  • qSum number

    Sum of all numerical values. NaN otherwise.

    format = double

  • qSum2 number

    Squared sum of all numerical values. NaN otherwise.

    format = double

  • qAverage number

    Average of all numerical values. NaN otherwise.

    format = double

  • qMedian number

    Median of all numerical values. NaN otherwise.

    format = double

  • qStd number

    Standard deviation of numerical values. NaN otherwise.

    format = double

  • qMin number

    Minimum value of numerical values. NaN otherwise.

    format = double

  • qMax number

    Maximum value of numerical values. NaN otherwise.

    format = double

  • qSkewness number

    Skewness of the numerical values. NaN otherwise.

    format = double

  • qKurtosis number

    Kurtosis of the numerical values. NaN otherwise.

    format = double

  • qFractiles array of numbers

    The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

  • qEmptyStrings integer

    Number of empty strings

    format = int64

  • qMaxStringLen integer

    Maximum string length of textual values. 0 otherwise.

    format = int64

  • qMinStringLen integer

    Minimum string length of textual values. 0 otherwise.

    format = int64

  • qSumStringLen integer

    Sum of all characters in strings in the field

    format = int64

  • qAvgStringLen number

    Average string length of textual values. 0 otherwise.

    format = double

  • qFirstSorted string

    For textual values the first sorted string.

  • qLastSorted string

    For textual values the last sorted string.

  • qMostFrequent array of objects

    Three most frequent values and their frequencies

    Show qMostFrequent properties
    • qSymbol object
      Show qSymbol properties
      • qText string

        String value of the symbol. This parameter is optional and present only if Symbol is a string.

      • qNumber number

        Numeric value of the symbol. NaN otherwise.

        format = double

    • qFrequency integer

      Frequency of the above symbol in the field

      format = int64

  • qFrequencyDistribution object
    Show qFrequencyDistribution properties
    • qNumberOfBins integer

      Number of bins.

      format = int32

    • qBinsEdges array of numbers

      Bins edges.

    • qFrequencies array of integers

      Bins frequencies.
  • qDataEvenness number

    Data evenness aka Shannon's entropy normalized to [0,1]

    format = double

schemas FieldList object

Lists the fields present in the data model viewer. Is the layout for FieldListDef.

Properties

  • qItems array of objects

    Array of items.

    Show qItems properties
    • qIsSemantic boolean

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

    • qIsHidden boolean

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

    • qIsSystem boolean

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

    • qAndMode boolean

      If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.

    • qName string

      Name of the field

    • qCardinal integer

      Number of distinct field values

      format = int32

    • qTags array of strings

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

    • qIsDefinitionOnly boolean

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

    • qDerivedFieldData object
      Show qDerivedFieldData properties
      • qDerivedFieldLists array of objects

        Information about the derived fields.

        Show qDerivedFieldLists properties
        • qDerivedDefinitionName string

          Name of the derived definition.

        • qFieldDefs array of objects

          List of the derived fields.

          Show qFieldDefs properties
          • qId string

            Identifier of the derived field. The identifier is unique.

          • qName string

            Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year

          • qMethod string

            Method name associated to the derived field.

          • qExpr string

            Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year , the expression is as follows: =${Mydefinition(OrderDate).Year}

          • qTags array of strings

            List of tags.
        • qGroupDefs array of objects

          List of the derived groups.

          Show qGroupDefs properties
          • qId string

            Identifier of the group.

          • qName string

            Name of the derived group.

          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            List of the derived fields in the group.
        • qTags array of strings

          List of tags on the derived fields.
    • qIsDetail boolean

      Is used for Direct Discovery. If set to true, it means that the type of the field is detail.

    • qIsImplicit boolean

      Is used for Direct Discovery. If set to true, it means that the type of the field is measure.

    • qReadableName string

schemas FieldListDef object

Defines the fields to show.

Properties

  • qShowSystem boolean

    Shows the system tables if set to true. Default is false.

    default = false

  • qShowHidden boolean

    Shows the hidden fields if set to true. Default is false.

    default = false

  • qShowSemantic boolean

    Show the semantic fields if set to true. Default is false.

    default = false

  • qShowSrcTables boolean

    Shows the tables and fields present in the data model viewer if set to true. Default is false.

    default = false

  • qShowDefinitionOnly boolean

    Shows the fields defined on the fly if set to true. Default is false.

    default = false

  • qShowDerivedFields boolean

    Shows the fields and derived fields if set to true. Default is false.

    default = false

  • qShowImplicit boolean

    Shows the Direct Discovery measure fields if set to true. Default is false.

    default = false

schemas FieldOrColumn object

Properties

  • qFieldName string

    Name of the field or column to be matched.

  • qTableName string

    Name of the table to be matched on. This parameter is optional. If TableName is set, FieldName represent the Table column with that name. If TableName is not set, FieldName represents the the field with that name.

schemas FieldScores object

Properties

  • qFieldName string

    Field name. One of the field names defined in qFieldPairName.

  • qReadableName string
  • qCardinalRatio number

    Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key.

    format = double

  • qSymbolScore number

    Number of distinct matches between the two fields defined in qFieldPairName divided by the number of distinct values in the field qFieldName . If 0, it means that there are no common values between the two fields defined in qFieldPairName .

    format = double

  • qRowScore number

    Number of matches between the two fields defined in qFieldPairName divided by the number of values in the field qFieldName . If 0, it means that there are no common values between the two fields defined in qFieldPairName .

    format = double

schemas FieldType string

oneOf

  • NOT_PRESENT

  • PRESENT

  • IS_CYCLIC_GROUP

  • IS_DRILL_GROUP

  • IS_VAR

  • IS_EXPR

  • IS_IMPLICIT

  • IS_DETAIL

schemas FieldValue object

Properties

  • qText string

    Text related to the field value. This parameter is optional.

  • qIsNumeric boolean

    Is set to true if the value is a numeric. This parameter is optional. Default is false.

  • qNumber number

    Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

    format = double

schemas FileDataFormat object

FileType

Recognized file formats are:

  • CSV for Delimited
  • FIX for Fixed Record
  • DIF for Data Interchange Format
  • EXCEL_BIFF for Microsoft Excel (XLS)
  • EXCEL_OOXML for Microsoft Excel (XLSX)
  • HTML for HTML
  • QVD for QVD file
  • XML for XML
  • QVX for QVX file
  • JSON for JSON format
  • KML for KML file
  • PARQUET for PARQUET file
  • GOOGLE_SHEET for Google Sheet file

Properties

  • qType string

    Can be one of: "CSV""FIX""DIF""EXCEL_BIFF""EXCEL_OOXML""HTML""QVD""XML""QVX""JSON""KML""PARQUET""GOOGLE_SHEET"

  • qLabel string

    One of:

    • Embedded labels (field names are present in the file)
    • No labels
    • Explicit labels (for DIFfiles)
  • qQuote string

    One of:

    • None (no quotes)
    • MSQ (Modern Style Quoting)
    • Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value)

    This property is used for delimited files.

  • qComment string

    String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files.

  • qDelimiter object
    Show qDelimiter properties
    • qName string

      Name of the delimiter. Example: "Tab_DELIMITER"

    • qScriptCode string

      Representation of the delimiter value that is used in the script. Example: "'\t'"

    • qNumber integer

      Delimiter character number used by the engine to determine how to separate the values.

      format = int32

    • qIsMultiple boolean

      Is set to true if multiple spaces are used to separate the values.
  • qCodePage integer

    Character set used in the file.

    format = int32

  • qHeaderSize integer

    Size of the header. Example: If the header size is 2, the first two rows in the file are considered as header and not as data. The header can contain the field names.

    format = int32

  • qRecordSize integer

    Record length. Each record (row of data) contains a number of columns with a fixed field size. This property is used for fixed record data files.

    format = int32

  • qTabSize integer

    Number of spaces that one tab character represents in the table file. This property is used for fixed record data files.

    format = int32

  • qIgnoreEOF boolean

    Is set to true, the end-of-file character is not taken into account during reload. This property is used for delimited files and fixed record data files.

  • qFixedWidthDelimiters string

    Positions of the field breaks in the table. This property is used for fixed record data files.

schemas FileType string

oneOf

  • CSV

    FILE_TYPE_CSV

  • FIX

    FILE_TYPE_FIX

  • DIF

    FILE_TYPE_DIF

  • EXCEL_BIFF

    FILE_TYPE_EXCEL_BIFF

  • EXCEL_OOXML

    FILE_TYPE_EXCEL_OOXML

  • HTML

    FILE_TYPE_HTML

  • QVD

    FILE_TYPE_QVD

  • XML

    FILE_TYPE_XML

  • QVX

    FILE_TYPE_QVX

  • JSON

    FILE_TYPE_JSON

  • KML

    FILE_TYPE_KML

  • PARQUET

    FILE_TYPE_PARQUET

  • GOOGLE_SHEET

    FILE_TYPE_GOOGLE_SHEET

schemas FilterInfo object

Properties

  • qType string

    Can be one of: "NONE""RAW"

  • qWherePredicate string

schemas FilterType string

oneOf

  • NONE

    FILTER_TYPE_NONE

  • RAW

    FILTER_TYPE_RAW

schemas FolderItem object

Properties

  • qName string

    Name of the folder item.

  • qType string

    Can be one of: "FOLDER""FILE""OTHER"

schemas FolderItemType string

oneOf

  • FOLDER

    FOLDER_ITEM_FOLDER

  • FILE

    FOLDER_ITEM_FILE

  • OTHER

    FOLDER_ITEM_OTHER

schemas FrequencyDistributionData object

Properties

  • qNumberOfBins integer

    Number of bins.

    format = int32

  • qBinsEdges array of numbers

    Bins edges.

  • qFrequencies array of integers

    Bins frequencies.

schemas Function object

Properties

  • qName string

    Name of the script function.

  • qGroup string

    Can be one of: "ALL""U""NONE""AGGR""NUM""RNG""EXP""TRIG""FIN""MATH""COUNT""STR""MAPP""RCRD""CND""LOG""NULL""SYS""FILE""TBL""DATE""NUMI""FRMT""CLR""RNK""GEO""EXT""PROB""ARRAY""LEG""DB""WINDOW"

  • qSignature string

    Signature of the script function. Gives general information about the function.

schemas FunctionGroup string

oneOf

  • ALL

    FUNC_GROUP_ALL

  • U

    FUNC_GROUP_UNKNOWN

  • NONE

    FUNC_GROUP_NONE

  • AGGR

    FUNC_GROUP_AGGR

  • NUM

    FUNC_GROUP_NUMERIC

  • RNG

    FUNC_GROUP_RANGE

  • EXP

    FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC

  • TRIG

    FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC

  • FIN

    FUNC_GROUP_FINANCIAL

  • MATH

    FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE

  • COUNT

    FUNC_GROUP_COUNTER

  • STR

    FUNC_GROUP_STRING

  • MAPP

    FUNC_GROUP_MAPPING

  • RCRD

    FUNC_GROUP_INTER_RECORD

  • CND

    FUNC_GROUP_CONDITIONAL

  • LOG

    FUNC_GROUP_LOGICAL

  • NULL

    FUNC_GROUP_NULL

  • SYS

    FUNC_GROUP_SYSTEM

  • FILE

    FUNC_GROUP_FILE

  • TBL

    FUNC_GROUP_TABLE

  • DATE

    FUNC_GROUP_DATE_AND_TIME

  • NUMI

    FUNC_GROUP_NUMBER_INTERPRET

  • FRMT

    FUNC_GROUP_FORMATTING

  • CLR

    FUNC_GROUP_COLOR

  • RNK

    FUNC_GROUP_RANKING

  • GEO

    FUNC_GROUP_GEO

  • EXT

    FUNC_GROUP_EXTERNAL

  • PROB

    FUNC_GROUP_PROBABILITY

  • ARRAY

    FUNC_GROUP_ARRAY

  • LEG

    FUNC_GROUP_LEGACY

  • DB

    FUNC_GROUP_DB_NATIVE

  • WINDOW

    FUNC_GROUP_WINDOW

schemas GenericBookmarkEntry object

Properties

  • qProperties object
    Show qProperties properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qIncludeVariables boolean
      Experimental

      If true all variables will be stored in the bookmark.

      default = false

    • qDistinctValues boolean
      Experimental

      If true all selected values will be stored distinct, i.e. searchstrings will not be kept.

      default = false

  • qBookmark object
    Show qBookmark properties
    • qStateData array of objects

      List of selections for each state.

      Show qStateData properties
      • qStateName string

        Name of the alternate state. Default is current selections: $

      • qFieldItems array of objects

        List of the selections.

        Show qFieldItems properties
        • qDef object
          Show qDef properties
          • qName string

            Name of the field.

          • qType string

            Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

        • qLocked boolean

          Indicates if the field is locked. Default is false.

        • qSelectInfo object
          Show qSelectInfo properties
          • qTextSearch string

            Text search string. Everything that matches the text is selected. This parameter is optional.

          • qRangeLo number

            Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

            default = -1e+300, format = double, default = -1e+300

          • qRangeHi number

            Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

            default = -1e+300, format = double, default = -1e+300

          • qNumberFormat object

            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:

            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.

            Show qNumberFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRangeInfo array of objects

            This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

            Show qRangeInfo properties
            • qRangeLo number

              Lowest value in the range.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value in the range.

              default = -1e+300, format = double, default = -1e+300

            • qMeasure string

              Label of the measure.
          • qSoftLock boolean

            Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

            default = false

          • qContinuousRangeInfo array of objects

            List of information about ranges for selections.

            Show qContinuousRangeInfo properties
            • qMin number

              Lowest value in the range

              format = double

            • qMax number

              Highest value in the range

              format = double

            • qMinInclEq boolean

              If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

            • qMaxInclEq boolean

              If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
          • qSelectFieldSearch boolean

            This parameter is true if the TextSearch is a result of a Select Field operation.

            default = false

        • qValues array of objects
          Show qValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qExcludedValues array of objects

          List of excluded values. Either the list of selected values or the list of excluded values is displayed.

          Show qExcludedValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qAndMode boolean

          If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

        • qOneAndOnlyOne boolean

          If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

        • qValuesCount integer

          Count of selected values. Indicates if the Values field is loaded.

          default = -1, format = int32, default = -1

        • qExcludedValuesCount integer

          Count of excluded values. Indicates if the ExcludedValues field is loaded.

          default = -1, format = int32, default = -1

    • qUtcModifyTime number

      Time when the bookmark was created.

      format = double

    • qVariableItems array of objects

      List of the variables in the app at the time the bookmark was created.

      Show qVariableItems properties
      • qName string

        Name of the variable.

      • qValue object
        Show qValue properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qDefinition string

        The Reporting mode definition of the variable.
    • qPatches array of objects

      Softpatches to be applied with this bookmark.

      Show qPatches properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qPatches array of objects

        Array with patches.

        Show qPatches properties
        • qOp string

          Can be one of: "add""remove""replace"

        • qPath string

          Path to the property to add, remove or replace.

        • qValue string

          This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
      • qChildren array of undefineds

        Array with child objects and their patches.
    • qCyclicGroupStates array of objects

      Information about cyclic groups by zero-based index. This field is unused.

      Show qCyclicGroupStates properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qActiveField integer

        Active field of the cyclic group, identified by a zero-based index.

        format = int32

    • qGroupStates array of objects
      Experimental

      Information about cyclic groups indexed by field definition.

      Show qGroupStates properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qActiveFieldDef string

        String defining the active field.
  • qClassicBookmark object
    Show qClassicBookmark properties
    • qId string
    • qName string
    • qUtcModifyTime number

      format = double

    • qUtcRecallTime number

      format = double

    • qRecallCount integer

      format = int32

    • qApplyAdditive boolean
    • qFieldItems array of objects
      Show qFieldItems properties
      • qDef object
        Show qDef properties
        • qName string

          Name of the field.

        • qType string

          Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

      • qLocked boolean

        Indicates if the field is locked. Default is false.

      • qSelectInfo object
        Show qSelectInfo properties
        • qTextSearch string

          Text search string. Everything that matches the text is selected. This parameter is optional.

        • qRangeLo number

          Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

          default = -1e+300, format = double, default = -1e+300

        • qRangeHi number

          Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

          default = -1e+300, format = double, default = -1e+300

        • qNumberFormat object

          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:

          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.

          Show qNumberFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRangeInfo array of objects

          This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

          Show qRangeInfo properties
          • qRangeLo number

            Lowest value in the range.

            default = -1e+300, format = double, default = -1e+300

          • qRangeHi number

            Highest value in the range.

            default = -1e+300, format = double, default = -1e+300

          • qMeasure string

            Label of the measure.
        • qSoftLock boolean

          Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

          default = false

        • qContinuousRangeInfo array of objects

          List of information about ranges for selections.

          Show qContinuousRangeInfo properties
          • qMin number

            Lowest value in the range

            format = double

          • qMax number

            Highest value in the range

            format = double

          • qMinInclEq boolean

            If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

          • qMaxInclEq boolean

            If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
        • qSelectFieldSearch boolean

          This parameter is true if the TextSearch is a result of a Select Field operation.

          default = false

      • qValues array of objects
        Show qValues properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qExcludedValues array of objects

        List of excluded values. Either the list of selected values or the list of excluded values is displayed.

        Show qExcludedValues properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qAndMode boolean

        If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

      • qOneAndOnlyOne boolean

        If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

      • qValuesCount integer

        Count of selected values. Indicates if the Values field is loaded.

        default = -1, format = int32, default = -1

      • qExcludedValuesCount integer

        Count of excluded values. Indicates if the ExcludedValues field is loaded.

        default = -1, format = int32, default = -1

    • qVariableItems array of objects
      Show qVariableItems properties
      • qName string

        Name of the variable.

      • qValue object
        Show qValue properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qDefinition string

        The Reporting mode definition of the variable.
    • qSheetId string
    • qObjects array of objects
      Show qObjects properties
      • qId string
      • qActive boolean
      • qShowMode integer

        format = byte

      • qScrollPos object
        Show qScrollPos properties
        • qUsePosition boolean
        • qPos object
          Show qPos properties
          • qx integer

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qy integer

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

    • qApplyLayoutState boolean

      default = false

    • qShowPopupInfo boolean

      default = false

    • qInfoText string
    • qOwner string
    • qGroups array of objects
      Show qGroups properties
      • qId string
      • qCyclePos integer

        format = int32

    • qShow object
      Show qShow properties
      • qAlways boolean

        default = true

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
    • qApplyInputFieldValues boolean

      default = true

    • qInputFieldItems array of objects
      Show qInputFieldItems properties
      • qFieldName string
      • qValues array of objects
        Show qValues properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qPackedHashKeys array of integers
    • qObjectsLayout array of objects
      Show qObjectsLayout properties
      • qId string
      • qActive boolean
      • qShowMode integer

        format = byte

      • qScrollPos object
        Show qScrollPos properties
        • qUsePosition boolean
        • qPos object
          Show qPos properties
          • qx integer

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qy integer

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

      • qExpansionInfo array of objects
        Show qExpansionInfo properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qLeftCollapsed boolean
      • qTopCollapsed boolean
      • qSortData array of objects
        Show qSortData properties
        • qName string
        • qReversed boolean
      • qDimensionGroupPos array of objects
        Show qDimensionGroupPos properties
        • qGroupName string
        • qCurrentItemName string
      • qExpressionGroupPos array of objects
        Show qExpressionGroupPos properties
        • qGroupName string
        • qCurrentItemName string
      • qUseGraphMode boolean
      • qGraphMode string

        Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"

      • qActiveContainerChildObjectId string
      • qExtendedPivotState object
        Show qExtendedPivotState properties
        • qExpressionPosition integer

          format = byte

        • qNumberOfLeftDimensions integer

          format = byte

        • qDimensionNames array of strings
        • qEnableConditions array of strings
    • qIncludeSelectionState boolean

      default = true

    • qIncludeScrollPosition boolean
    • qAlternateStateData array of objects
      Show qAlternateStateData properties
      • qStateName string

        Name of the alternate state. Default is current selections: $

      • qFieldItems array of objects

        List of the selections.

        Show qFieldItems properties
        • qDef object
          Show qDef properties
          • qName string

            Name of the field.

          • qType string

            Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

        • qLocked boolean

          Indicates if the field is locked. Default is false.

        • qSelectInfo object
          Show qSelectInfo properties
          • qTextSearch string

            Text search string. Everything that matches the text is selected. This parameter is optional.

          • qRangeLo number

            Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

            default = -1e+300, format = double, default = -1e+300

          • qRangeHi number

            Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

            default = -1e+300, format = double, default = -1e+300

          • qNumberFormat object

            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:

            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.

            Show qNumberFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRangeInfo array of objects

            This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

            Show qRangeInfo properties
            • qRangeLo number

              Lowest value in the range.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value in the range.

              default = -1e+300, format = double, default = -1e+300

            • qMeasure string

              Label of the measure.
          • qSoftLock boolean

            Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

            default = false

          • qContinuousRangeInfo array of objects

            List of information about ranges for selections.

            Show qContinuousRangeInfo properties
            • qMin number

              Lowest value in the range

              format = double

            • qMax number

              Highest value in the range

              format = double

            • qMinInclEq boolean

              If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

            • qMaxInclEq boolean

              If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
          • qSelectFieldSearch boolean

            This parameter is true if the TextSearch is a result of a Select Field operation.

            default = false

        • qValues array of objects
          Show qValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qExcludedValues array of objects

          List of excluded values. Either the list of selected values or the list of excluded values is displayed.

          Show qExcludedValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qAndMode boolean

          If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

        • qOneAndOnlyOne boolean

          If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

        • qValuesCount integer

          Count of selected values. Indicates if the Values field is loaded.

          default = -1, format = int32, default = -1

        • qExcludedValuesCount integer

          Count of excluded values. Indicates if the ExcludedValues field is loaded.

          default = -1, format = int32, default = -1

    • qForAnnotations boolean
    • qIncludeAllVariables boolean

      default = false

  • qClassicMetadata object
    Show qClassicMetadata properties
    • qShared boolean
    • qUtcModifyTime number

      format = double

    • qSheetId string
    • qTemporary boolean
    • qRestrictedAccess boolean
    • qAccessList array of strings
    • qPersonalEditionHash_OBSOLETE string
    • qHidden boolean

      default = false

    • qLinkedTo array of strings

schemas GenericBookmarkLayout object

Is the layout for GenericBookmarkProperties.

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qBookmark object
    Show qBookmark properties
    • qStateData array of objects

      List of selections for each state.

      Show qStateData properties
      • qStateName string

        Name of the alternate state. Default is current selections: $

      • qFieldItems array of objects

        List of the selections.

        Show qFieldItems properties
        • qDef object
          Show qDef properties
          • qName string

            Name of the field.

          • qType string

            Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

        • qLocked boolean

          Indicates if the field is locked. Default is false.

        • qSelectInfo object
          Show qSelectInfo properties
          • qTextSearch string

            Text search string. Everything that matches the text is selected. This parameter is optional.

          • qRangeLo number

            Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

            default = -1e+300, format = double, default = -1e+300

          • qRangeHi number

            Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

            default = -1e+300, format = double, default = -1e+300

          • qNumberFormat object

            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:

            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.

            Show qNumberFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRangeInfo array of objects

            This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

            Show qRangeInfo properties
            • qRangeLo number

              Lowest value in the range.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value in the range.

              default = -1e+300, format = double, default = -1e+300

            • qMeasure string

              Label of the measure.
          • qSoftLock boolean

            Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

            default = false

          • qContinuousRangeInfo array of objects

            List of information about ranges for selections.

            Show qContinuousRangeInfo properties
            • qMin number

              Lowest value in the range

              format = double

            • qMax number

              Highest value in the range

              format = double

            • qMinInclEq boolean

              If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

            • qMaxInclEq boolean

              If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
          • qSelectFieldSearch boolean

            This parameter is true if the TextSearch is a result of a Select Field operation.

            default = false

        • qValues array of objects
          Show qValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qExcludedValues array of objects

          List of excluded values. Either the list of selected values or the list of excluded values is displayed.

          Show qExcludedValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qAndMode boolean

          If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

        • qOneAndOnlyOne boolean

          If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

        • qValuesCount integer

          Count of selected values. Indicates if the Values field is loaded.

          default = -1, format = int32, default = -1

        • qExcludedValuesCount integer

          Count of excluded values. Indicates if the ExcludedValues field is loaded.

          default = -1, format = int32, default = -1

    • qUtcModifyTime number

      Time when the bookmark was created.

      format = double

    • qVariableItems array of objects

      List of the variables in the app at the time the bookmark was created.

      Show qVariableItems properties
      • qName string

        Name of the variable.

      • qValue object
        Show qValue properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qDefinition string

        The Reporting mode definition of the variable.
    • qPatches array of objects

      Softpatches to be applied with this bookmark.

      Show qPatches properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qPatches array of objects

        Array with patches.

        Show qPatches properties
        • qOp string

          Can be one of: "add""remove""replace"

        • qPath string

          Path to the property to add, remove or replace.

        • qValue string

          This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
      • qChildren array of undefineds

        Array with child objects and their patches.
    • qCyclicGroupStates array of objects

      Information about cyclic groups by zero-based index. This field is unused.

      Show qCyclicGroupStates properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qActiveField integer

        Active field of the cyclic group, identified by a zero-based index.

        format = int32

    • qGroupStates array of objects
      Experimental

      Information about cyclic groups indexed by field definition.

      Show qGroupStates properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qActiveFieldDef string

        String defining the active field.
  • qFieldInfos array of objects

    Information about the field selections associated with the bookmark.

    Show qFieldInfos properties
    • qFieldName string

      The name of the field.

    • qValuesCount integer

      Number of selected values in the field.

      format = int32

    • qExcludedValuesCount integer

      Number of excluded values in the field.

      format = int32

schemas GenericBookmarkProperties object

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMetaDef object

    Used to collect metadata.

    Properties

    Semantic type with an empty structure.

  • qIncludeVariables boolean
    Experimental

    If true all variables will be stored in the bookmark.

    default = false

  • qDistinctValues boolean
    Experimental

    If true all selected values will be stored distinct, i.e. searchstrings will not be kept.

    default = false

schemas GenericConnectMachine string

oneOf

  • CONNECT_DEFAULT

  • CONNECT_64

  • CONNECT_32

schemas GenericDimensionInfo object

Properties

  • qApprMaxGlyphCount integer

    Length of the longest value in the field.

    format = int32

  • qCardinal integer

    Number of distinct field values

    format = int32

  • qTags array of strings

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

  • qIsSemantic boolean

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

  • qAndMode boolean

    If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.

schemas GenericDimensionLayout object

Is the layout for GenericDimensionProperties.

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qDim object
    Show qDim properties
    • qGrouping string

      Can be one of: "N""H""C"

    • qFieldDefs array of strings

      Array of dimension names.

    • qFieldLabels array of strings

      Array of dimension labels.

    • qLabelExpression string
    • qAlias string

      Alias of the dimension.

    • qScriptGenerated boolean Deprecated
    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

  • qDimInfos array of objects

    Cardinal and tags related to the dimension. Length of the longest value in the field.

    Show qDimInfos properties
    • qApprMaxGlyphCount integer

      Length of the longest value in the field.

      format = int32

    • qCardinal integer

      Number of distinct field values

      format = int32

    • qTags array of strings

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

    • qIsSemantic boolean

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

    • qAndMode boolean

      If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.

schemas GenericDimensionProperties object

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qDim object
    Show qDim properties
    • qGrouping string

      Can be one of: "N""H""C"

    • qFieldDefs array of strings

      Array of dimension names.

    • qFieldLabels array of strings

      Array of dimension labels.

    • qLabelExpression string
    • qAlias string

      Alias of the dimension.

    • qScriptGenerated boolean Deprecated

      default = false

    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

  • qMetaDef object

    Used to collect metadata.

    Properties

    Semantic type with an empty structure.

schemas GenericMeasureLayout object

Is the layout for GenericMeasureProperties.

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMeasure object

    Information about the library measure. Is the layout for NxLibraryMeasureDef.

    Show qMeasure properties
    • qLabel string
    • qDef string
    • qGrouping string

      Can be one of: "N""H""C"

    • qExpressions array of strings
    • qActiveExpression integer

      format = int32

    • qLabelExpression string
    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qScriptGenerated boolean Deprecated
    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.

schemas GenericMeasureProperties object

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMeasure object
    Show qMeasure properties
    • qLabel string

      Label of the measure.

    • qDef string

      Definition of the measure.

    • qGrouping string

      Can be one of: "N""H""C"

    • qExpressions array of strings

      Array of expressions.

    • qActiveExpression integer

      Index to the active expression in a measure.

      format = int32

    • qLabelExpression string

      Optional expression used for dynamic label.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qScriptGenerated boolean Deprecated

      default = false

    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

  • qMetaDef object

    Used to collect metadata.

    Properties

    Semantic type with an empty structure.

schemas GenericObjectEntry object

Properties

  • qProperty object
    Show qProperty properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qExtendsId string

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDef object

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qType string

        Type of the app list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDef object

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qIncludePatches boolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDef object

      Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

      Show qChildListDef properties
      • qData object

        Contains dynamic JSON data specified by the client.
    • qDimensionListDef object

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDef object

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDef object

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDef object

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystem boolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHidden boolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemantic boolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTables boolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnly boolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFields boolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicit boolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDef object

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

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

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qIncludeElemValue boolean
        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowTotal boolean
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
      • qMeasures array of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

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

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qInterColumnSortOrder array of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qInitialDataFetch array of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionMode string

        Can be one of: "N""D1""S""C""ST"

      • qMode string

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPos integer

        default = -1, format = int32, default = -1

      • qNoOfLeftDims integer

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpanded boolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCells integer

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAbove boolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentMode boolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qSortbyYValue integer

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qColumnOrder array of integers

        The order of the columns.

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qDynamicScript array of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.

      • qSuppressMeasureTotals boolean

        When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
    • qLayoutExclude object

      Contains JSON to be excluded from validation.

    • qListObjectDef object

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSort boolean

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

        • qActiveField integer

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

          Alias of the dimension.
      • qAutoSortByState object
        Show qAutoSortByState properties
        • qDisplayNumberOfRows integer

          This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyMode string

        Can be one of: "N""V""P""R"

      • qShowAlternatives boolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetch array of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressions array of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qLibraryId string

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedView boolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDef object

      Defines the list of measures.

      Show qMeasureListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qMediaListDef object

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDef object
      Show qNxLibraryDimensionDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDef object
      Show qNxLibraryMeasureDef properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

        Can be one of: "N""H""C"

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDef object

      To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

      Properties

      "qSelectionObjectDef": {}

      Show qSelectionObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDef object
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrl string

        Relative path of the thumbnail.
    • qStringExpression object

      Properties

      Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string
      The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      A string expression is not evaluated, if the expression is surrounded by simple quotes.
      The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
      Show qStringExpression properties
      • qExpr string
    • qTreeDataDef object

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

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

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qValueExprs array of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

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

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                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:

                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.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrder array of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qOpenFullyExpanded boolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qInitialDataFetch array of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodes integer

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodes array of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qArea object
            Show qArea properties
            • qLeft integer

              Position from the left. Corresponds to the first column.

              format = int32

            • qTop integer

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidth integer

              Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

            • qHeight integer

              Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

          • qAllValues boolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevels object
          Show qTreeLevels properties
          • qLeft integer

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepth integer

            Number of dimensions to include in the tree.

            default = -1, format = int32, default = -1

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension.

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qValueExprs array of objects

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

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

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.
    • qUndoInfoDef object

      Defines if an object should contain information on the number of possible undo and redo.

      Properties

      "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

    • qValueExpression object

      Properties

      Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string.
      The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      The expression is evaluated as a numeric.
      Show qValueExpression properties
      • qExpr string
    • qVariableListDef object

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qType string

        Type of variables to include in the list.

      • qShowReserved boolean

        Shows the reserved variables if set to true.

      • qShowConfig boolean

        Shows the system variables if set to true.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qShowSession boolean

        Shows the session variables if set to true.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
  • qChildren array of objects

    Information about the children of the generic object.

    Show qChildren properties
    • qProperty object
      Show qProperty properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qExtendsId string

        Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

      • qMetaDef object

        Used to collect metadata.

        Properties

        Semantic type with an empty structure.

      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qAppObjectListDef object

        Defines the list of objects in an app.

        An app object is a generic object created at app level.
        Show qAppObjectListDef properties
        • qType string

          Type of the app list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qBookmarkListDef object

        Defines the list of bookmarks.

        Show qBookmarkListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.

        • qIncludePatches boolean

          Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
      • qChildListDef object

        Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

        Show qChildListDef properties
        • qData object

          Contains dynamic JSON data specified by the client.
      • qDimensionListDef object

        Defines the lists of dimensions.

        Show qDimensionListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qEmbeddedSnapshotDef object

        Defines the embedded snapshot in a generic object.

        Properties

        "EmbeddedSnapshotDef": {}

      • qExtensionListDef object

        Obsolete, use qrs API's to fetch extensions.

      • qFieldListDef object

        Defines the fields to show.

        Show qFieldListDef properties
        • qShowSystem boolean

          Shows the system tables if set to true. Default is false.

          default = false

        • qShowHidden boolean

          Shows the hidden fields if set to true. Default is false.

          default = false

        • qShowSemantic boolean

          Show the semantic fields if set to true. Default is false.

          default = false

        • qShowSrcTables boolean

          Shows the tables and fields present in the data model viewer if set to true. Default is false.

          default = false

        • qShowDefinitionOnly boolean

          Shows the fields defined on the fly if set to true. Default is false.

          default = false

        • qShowDerivedFields boolean

          Shows the fields and derived fields if set to true. Default is false.

          default = false

        • qShowImplicit boolean

          Shows the Direct Discovery measure fields if set to true. Default is false.

          default = false

      • qHyperCubeDef object

        Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

        Show qHyperCubeDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qDimensions array of objects

          Array of dimensions.

          Show qDimensions properties
          • qLibraryId string

            Refers to a dimension stored in the library.

          • qDef object
            Show qDef properties
            • qGrouping string

              Can be one of: "N""H""C"

            • qFieldDefs array of strings

              Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

            • qFieldLabels array of strings

              Array of field labels. This parameter is optional.

            • qSortCriterias array of objects

              Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

              Show qSortCriterias properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qNumberPresentations array of objects

              Defines the format of the value. This parameter is optional.

              Show qNumberPresentations properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qReverseSort boolean

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

            • qActiveField integer

              Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

              format = int32

            • qLabelExpression string

              Label expression. This parameter is optional.

            • qAlias string

              Alias of the dimension.
          • qNullSuppression boolean

            If set to true, no null values are returned.

          • qIncludeElemValue boolean
          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qShowTotal boolean
          • qShowAll boolean

            If set to true, all dimension values are shown.

          • qOtherLabel object
            Show qOtherLabel properties
            • qv string

              Expression evaluated to string.
          • qTotalLabel object
            Show qTotalLabel properties
            • qv string

              Expression evaluated to string.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
        • qMeasures array of objects

          Array of measures.

          Show qMeasures properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

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

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                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:

                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.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qInterColumnSortOrder array of integers

          Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

        • qSuppressZero boolean

          Removes zero values.

          default = false

        • qSuppressMissing boolean

          Removes missing values.

          default = false

        • qInitialDataFetch array of objects

          Initial data set.

          Show qInitialDataFetch properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qReductionMode string

          Can be one of: "N""D1""S""C""ST"

        • qMode string

          Can be one of: "S""P""K""T""D"

        • qPseudoDimPos integer

          default = -1, format = int32, default = -1

        • qNoOfLeftDims integer

          Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

          • Four dimensions in the following order: Country, City, Product and Category.
          • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
          • Three left dimensions ( qNoOfLeftDims is set to 3).

          implies that:

          • The index 0 corresponds to the left dimension Country.
          • The index 1 corresponds to the pseudo dimension.
          • The index 2 corresponds to the left dimension City.
          • Product and Category are top dimensions.

          Another example:

          • Four dimensions in the following order: Country, City, Product and Category.
          • Three left dimensions ( qNoOfLeftDims is set to 3).
          • One pseudo dimension.
          • The property qInterColumnSortOrder is left empty.

          Implies that:

          • The index 0 corresponds to the left dimension Country.
          • The index 1 corresponds to the left dimension City.
          • The index 2 corresponds to the left dimension Product.
          • Category is a top dimension.
          • The pseudo dimension is a top dimension.

          default = -1, format = int32, default = -1

        • qAlwaysFullyExpanded boolean

          If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

          default = false

        • qMaxStackedCells integer

          Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

          default = 5000, format = int32, default = 5000

        • qPopulateMissing boolean

          If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

          default = false

        • qShowTotalsAbove boolean

          If set to true, the total (if any) is shown on the first row. The default value is false.

          default = false

        • qIndentMode boolean

          This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

          default = false

        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qSortbyYValue integer

          To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

          default = 0, format = int8, default = 0

        • qTitle object
          Show qTitle properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qColumnOrder array of integers

          The order of the columns.

        • qExpansionState array of objects
          Experimental

          Expansion state per dimension for pivot mode ( qMode is P).

          Show qExpansionState properties
          • qExcludeList boolean
          • qPos object
            Show qPos properties
            • qDimName string
            • qElemNo array of integers
            • qElemValues array of strings
        • qDynamicScript array of strings
          Experimental

          Hypercube Modifier Dynamic script string

        • qContextSetExpression string

          Set expression valid for the whole cube, limiting computations to the specified set.

        • qSuppressMeasureTotals boolean

          When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
      • qLayoutExclude object

        Contains JSON to be excluded from validation.

      • qListObjectDef object

        Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

        Show qListObjectDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

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

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qAutoSortByState object
          Show qAutoSortByState properties
          • qDisplayNumberOfRows integer

            This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

            format = int32

        • qFrequencyMode string

          Can be one of: "N""V""P""R"

        • qShowAlternatives boolean

          If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

        • qInitialDataFetch array of objects

          Fetches an initial data set.

          Show qInitialDataFetch properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qExpressions array of objects

          Lists the expressions in the list object. This parameter is optional.

          Show qExpressions properties
          • qExpr string

            Value of the expression.

          • qLibraryId string

            Refers to an expression stored in the library.
        • qDirectQuerySimplifiedView boolean
          Experimental

          If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
      • qMeasureListDef object

        Defines the list of measures.

        Show qMeasureListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qMediaListDef object

        Defines the list of media files.

        This struct is deprecated.

        Properties

        "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

      • qNxLibraryDimensionDef object
        Show qNxLibraryDimensionDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of dimension names.

        • qFieldLabels array of strings

          Array of dimension labels.

        • qLabelExpression string
        • qAlias string

          Alias of the dimension.

        • qScriptGenerated boolean Deprecated

          default = false

        • qOrigin string

          Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

      • qNxLibraryMeasureDef object
        Show qNxLibraryMeasureDef properties
        • qLabel string

          Label of the measure.

        • qDef string

          Definition of the measure.

        • qGrouping string

          Can be one of: "N""H""C"

        • qExpressions array of strings

          Array of expressions.

        • qActiveExpression integer

          Index to the active expression in a measure.

          format = int32

        • qLabelExpression string

          Optional expression used for dynamic label.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qScriptGenerated boolean Deprecated

          default = false

        • qOrigin string

          Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

      • qSelectionObjectDef object

        To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

        Properties

        "qSelectionObjectDef": {}

        Show qSelectionObjectDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .
      • qStaticContentUrlDef object
        In addition, this structure can contain dynamic properties.
        Show qStaticContentUrlDef properties
        • qUrl string

          Relative path of the thumbnail.
      • qStringExpression object

        Properties

        Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

        • < expression > is a string
        The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
        A string expression is not evaluated, if the expression is surrounded by simple quotes.
        The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
        Show qStringExpression properties
        • qExpr string
      • qTreeDataDef object

        Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

        Show qTreeDataDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qDimensions array of objects

          Array of dimensions.

          Show qDimensions properties
          • qLibraryId string

            Refers to a dimension stored in the library.

          • qDef object
            Show qDef properties
            • qGrouping string

              Can be one of: "N""H""C"

            • qFieldDefs array of strings

              Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

            • qFieldLabels array of strings

              Array of field labels. This parameter is optional.

            • qSortCriterias array of objects

              Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

              Show qSortCriterias properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qNumberPresentations array of objects

              Defines the format of the value. This parameter is optional.

              Show qNumberPresentations properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qReverseSort boolean

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

            • qActiveField integer

              Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

              format = int32

            • qLabelExpression string

              Label expression. This parameter is optional.

            • qAlias string

              Alias of the dimension.
          • qValueExprs array of objects

            List of measures.

            Show qValueExprs properties
            • qLibraryId string

              Refers to a measure stored in the library.

            • qDef object
              Show qDef properties
              • qLabel string

                Name of the measure. An empty string is returned as a default value. This parameter is optional.

              • qDescription string

                Description of the measure. An empty string is returned as a default value. This parameter is optional.

              • qTags array of strings

                Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

              • qGrouping string

                Can be one of: "N""H""C"

              • qDef string

                Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

              • qNumFormat object

                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:

                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.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRelative boolean

                If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

              • qBrutalSum boolean

                If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

              • qAggrFunc string

                Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

              • qAccumulate integer
                • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

                format = int32

              • qReverseSort boolean

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

              • qActiveExpression integer

                Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

                format = int32

              • qExpressions array of strings

                Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

              • qLabelExpression string

                Label expression. This parameter is optional.
            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                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:

                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.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qAttributeDimensions array of objects

              List of attribute dimensions.

              Show qAttributeDimensions properties
              • qDef string

                Expression or field name.

              • qLibraryId string

                LibraryId for dimension.

              • qSortBy object
                Show qSortBy properties
                • qSortByState integer

                  Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                  format = int8

                • qSortByFrequency integer

                  Sorts the field values by frequency (number of occurrences in the field).

                  format = int8

                • qSortByNumeric integer

                  Sorts the field values by numeric value.

                  format = int8

                • qSortByAscii integer

                  Sorts the field by alphabetical order.

                  format = int8

                • qSortByLoadOrder integer

                  Sorts the field values by the initial load order.

                  format = int8

                • qSortByExpression integer

                  Sorts the field by expression.

                  format = int8

                • qExpression object
                  Show qExpression properties
                  • qv string

                    Expression evaluated to dual.
                • qSortByGreyness integer

                  format = int8

              • qAttribute boolean

                If set to true, this attribute will not affect the number of rows in the cube.
            • qCalcCond object
              Show qCalcCond properties
              • qv string

                Expression evaluated to dual.
            • qCalcCondition object
              Show qCalcCondition properties
              • qCond object
                Show qCond properties
                • qv string

                  Expression evaluated to dual.
              • qMsg object
                Show qMsg properties
                • qv string

                  Expression evaluated to string.
            • qTrendLines array of objects
              Experimental

              Specifies trendlines for this measure.

              Show qTrendLines properties
              • qType string

                Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

              • qXColIx integer

                The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

                default = -1, format = int32, default = -1

              • qCalcR2 boolean

                Set to true to calulatate the R2 score

                default = false

              • qContinuousXAxis string

                Can be one of: "Never""Possible""Time"

              • qMultiDimMode string

                Can be one of: "Multi""Sum"

            • qMiniChartDef object
              Show qMiniChartDef properties
              • qDef string

                Expression or field name.

              • qLibraryId string

                LibraryId for dimension.

              • qSortBy object
                Show qSortBy properties
                • qSortByState integer

                  Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                  format = int8

                • qSortByFrequency integer

                  Sorts the field values by frequency (number of occurrences in the field).

                  format = int8

                • qSortByNumeric integer

                  Sorts the field values by numeric value.

                  format = int8

                • qSortByAscii integer

                  Sorts the field by alphabetical order.

                  format = int8

                • qSortByLoadOrder integer

                  Sorts the field values by the initial load order.

                  format = int8

                • qSortByExpression integer

                  Sorts the field by expression.

                  format = int8

                • qExpression object
                  Show qExpression properties
                  • qv string

                    Expression evaluated to dual.
                • qSortByGreyness integer

                  format = int8

              • qOtherTotalSpec object
                Show qOtherTotalSpec properties
                • qOtherMode string

                  Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

                • qOtherCounted object
                  Show qOtherCounted properties
                  • qv string

                    Expression evaluated to dual.
                • qOtherLimit object
                  Show qOtherLimit properties
                  • qv string

                    Expression evaluated to dual.
                • qOtherLimitMode string

                  Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

                • qSuppressOther boolean

                  If set to true, the group Others is not displayed as a dimension value. The default value is false.

                  default = false

                • qForceBadValueKeeping boolean

                  This parameter is used when qOtherMode is set to:

                  • OTHER_ABS_LIMITED
                  • OTHER_REL_LIMITED
                  • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                  and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                  default = true

                • qApplyEvenWhenPossiblyWrongResult boolean

                  Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                  default = true

                • qGlobalOtherGrouping boolean

                  This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                  default = false

                • qOtherCollapseInnerDimensions boolean

                  If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                  default = false

                • qOtherSortMode string

                  Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

                • qTotalMode string

                  Can be one of: "TOTAL_OFF""TOTAL_EXPR"

                • qReferencedExpression object
                  Show qReferencedExpression properties
                  • qv string

                    Expression evaluated to string.
              • qMaxNumberPoints integer

                default = -1, format = int32, default = -1

              • qAttributeExpressions array of objects

                List of attribute expressions.

                Show qAttributeExpressions properties
                • qExpression string

                  Definition of the attribute expression. Example: "Max(OrderID)"

                • qLibraryId string

                  Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

                • qAttribute boolean

                  If set to true, this measure will not affect the number of rows in the cube.

                • qNumFormat object

                  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:

                  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.

                  Show qNumFormat properties
                  • qType string

                    Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                  • qnDec integer

                    Number of decimals. Default is 10.

                    default = 10, format = int32, default = 10

                  • qUseThou integer

                    Defines whether or not a thousands separator must be used. Default is 0.

                    default = 0, format = int32, default = 0

                  • qFmt string

                    Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                  • qDec string

                    Defines the decimal separator. Example: .

                  • qThou string

                    Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
                • qLabel string

                  Label of the attribute expression.

                • qLabelExpression string

                  Optional expression used for dynamic label.
              • qNullSuppression boolean

                If set to true, no null values are returned.
          • qNullSuppression boolean

            If set to true, no null values are returned.

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qShowAll boolean

            If set to true, all dimension values are shown.

          • qOtherLabel object
            Show qOtherLabel properties
            • qv string

              Expression evaluated to string.
          • qTotalLabel object
            Show qTotalLabel properties
            • qv string

              Expression evaluated to string.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
        • qInterColumnSortOrder array of integers

          Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

        • qSuppressZero boolean

          Removes zero values.

          default = false

        • qSuppressMissing boolean

          Removes missing values.

          default = false

        • qOpenFullyExpanded boolean

          If this property is set to true, the cells are opened expanded. The default value is false.

          default = false

        • qPopulateMissing boolean

          If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

          default = false

        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTitle object
          Show qTitle properties
          • qv string

            Expression evaluated to string.
        • qInitialDataFetch array of objects

          Initial data set. This property is optional.

          Show qInitialDataFetch properties
          • qMaxNbrOfNodes integer

            Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

            format = int32

          • qTreeNodes array of objects

            Defines areas of the tree to be fetched. Areas must be defined left to right.

            Show qTreeNodes properties
            • qArea object
              Show qArea properties
              • qLeft integer

                Position from the left. Corresponds to the first column.

                format = int32

              • qTop integer

                Position from the top. Corresponds to the first row.

                format = int32

              • qWidth integer

                Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

                format = int32

              • qHeight integer

                Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

                format = int32

            • qAllValues boolean

              When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
          • qTreeLevels object
            Show qTreeLevels properties
            • qLeft integer

              The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

              format = int32

            • qDepth integer

              Number of dimensions to include in the tree.

              default = -1, format = int32, default = -1

        • qExpansionState array of objects
          Experimental

          Expansion state per dimension.

          Show qExpansionState properties
          • qExcludeList boolean
          • qPos object
            Show qPos properties
            • qDimName string
            • qElemNo array of integers
            • qElemValues array of strings
        • qValueExprs array of objects

          List of measures to calculate on the whole tree.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

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

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                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:

                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.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qContextSetExpression string

          Set expression valid for the whole cube, limiting computations to the specified set.
      • qUndoInfoDef object

        Defines if an object should contain information on the number of possible undo and redo.

        Properties

        "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

      • qValueExpression object

        Properties

        Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

        • < expression > is a string.
        The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
        The expression is evaluated as a numeric.
        Show qValueExpression properties
        • qExpr string
      • qVariableListDef object

        Defines the list of variables in an app.

        Show qVariableListDef properties
        • qType string

          Type of variables to include in the list.

        • qShowReserved boolean

          Shows the reserved variables if set to true.

        • qShowConfig boolean

          Shows the system variables if set to true.

        • qData object

          Contains dynamic JSON data specified by the client.

        • qShowSession boolean

          Shows the session variables if set to true.
      Show additional optional properties
      • object object
        Private
        Any of:
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
    • qChildren array of undefineds

      Information about the children of the generic object.

    • qEmbeddedSnapshotRef object
      Show qEmbeddedSnapshotRef properties
      • qProperties object
        Show qProperties properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qMetaDef object

          Used to collect metadata.

          Properties

          Semantic type with an empty structure.

        • qIncludeVariables boolean
          Experimental

          If true all variables will be stored in the bookmark.

          default = false

        • qDistinctValues boolean
          Experimental

          If true all selected values will be stored distinct, i.e. searchstrings will not be kept.

          default = false

      • qBookmark object
        Show qBookmark properties
        • qStateData array of objects

          List of selections for each state.

          Show qStateData properties
          • qStateName string

            Name of the alternate state. Default is current selections: $

          • qFieldItems array of objects

            List of the selections.

            Show qFieldItems properties
            • qDef object
              Show qDef properties
              • qName string

                Name of the field.

              • qType string

                Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

            • qLocked boolean

              Indicates if the field is locked. Default is false.

            • qSelectInfo object
              Show qSelectInfo properties
              • qTextSearch string

                Text search string. Everything that matches the text is selected. This parameter is optional.

              • qRangeLo number

                Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qNumberFormat object

                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:

                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.

                Show qNumberFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRangeInfo array of objects

                This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

                Show qRangeInfo properties
                • qRangeLo number

                  Lowest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qRangeHi number

                  Highest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qMeasure string

                  Label of the measure.
              • qSoftLock boolean

                Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

                default = false

              • qContinuousRangeInfo array of objects

                List of information about ranges for selections.

                Show qContinuousRangeInfo properties
                • qMin number

                  Lowest value in the range

                  format = double

                • qMax number

                  Highest value in the range

                  format = double

                • qMinInclEq boolean

                  If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

                • qMaxInclEq boolean

                  If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
              • qSelectFieldSearch boolean

                This parameter is true if the TextSearch is a result of a Select Field operation.

                default = false

            • qValues array of objects
              Show qValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qExcludedValues array of objects

              List of excluded values. Either the list of selected values or the list of excluded values is displayed.

              Show qExcludedValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qAndMode boolean

              If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

            • qOneAndOnlyOne boolean

              If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

            • qValuesCount integer

              Count of selected values. Indicates if the Values field is loaded.

              default = -1, format = int32, default = -1

            • qExcludedValuesCount integer

              Count of excluded values. Indicates if the ExcludedValues field is loaded.

              default = -1, format = int32, default = -1

        • qUtcModifyTime number

          Time when the bookmark was created.

          format = double

        • qVariableItems array of objects

          List of the variables in the app at the time the bookmark was created.

          Show qVariableItems properties
          • qName string

            Name of the variable.

          • qValue object
            Show qValue properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qDefinition string

            The Reporting mode definition of the variable.
        • qPatches array of objects

          Softpatches to be applied with this bookmark.

          Show qPatches properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qPatches array of objects

            Array with patches.

            Show qPatches properties
            • qOp string

              Can be one of: "add""remove""replace"

            • qPath string

              Path to the property to add, remove or replace.

            • qValue string

              This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
          • qChildren array of undefineds

            Array with child objects and their patches.
        • qCyclicGroupStates array of objects

          Information about cyclic groups by zero-based index. This field is unused.

          Show qCyclicGroupStates properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qActiveField integer

            Active field of the cyclic group, identified by a zero-based index.

            format = int32

        • qGroupStates array of objects
          Experimental

          Information about cyclic groups indexed by field definition.

          Show qGroupStates properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qActiveFieldDef string

            String defining the active field.
      • qClassicBookmark object
        Show qClassicBookmark properties
        • qId string
        • qName string
        • qUtcModifyTime number

          format = double

        • qUtcRecallTime number

          format = double

        • qRecallCount integer

          format = int32

        • qApplyAdditive boolean
        • qFieldItems array of objects
          Show qFieldItems properties
          • qDef object
            Show qDef properties
            • qName string

              Name of the field.

            • qType string

              Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

          • qLocked boolean

            Indicates if the field is locked. Default is false.

          • qSelectInfo object
            Show qSelectInfo properties
            • qTextSearch string

              Text search string. Everything that matches the text is selected. This parameter is optional.

            • qRangeLo number

              Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qNumberFormat object

              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:

              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.

              Show qNumberFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRangeInfo array of objects

              This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

              Show qRangeInfo properties
              • qRangeLo number

                Lowest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qMeasure string

                Label of the measure.
            • qSoftLock boolean

              Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

              default = false

            • qContinuousRangeInfo array of objects

              List of information about ranges for selections.

              Show qContinuousRangeInfo properties
              • qMin number

                Lowest value in the range

                format = double

              • qMax number

                Highest value in the range

                format = double

              • qMinInclEq boolean

                If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

              • qMaxInclEq boolean

                If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
            • qSelectFieldSearch boolean

              This parameter is true if the TextSearch is a result of a Select Field operation.

              default = false

          • qValues array of objects
            Show qValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qExcludedValues array of objects

            List of excluded values. Either the list of selected values or the list of excluded values is displayed.

            Show qExcludedValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qAndMode boolean

            If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

          • qOneAndOnlyOne boolean

            If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

          • qValuesCount integer

            Count of selected values. Indicates if the Values field is loaded.

            default = -1, format = int32, default = -1

          • qExcludedValuesCount integer

            Count of excluded values. Indicates if the ExcludedValues field is loaded.

            default = -1, format = int32, default = -1

        • qVariableItems array of objects
          Show qVariableItems properties
          • qName string

            Name of the variable.

          • qValue object
            Show qValue properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qDefinition string

            The Reporting mode definition of the variable.
        • qSheetId string
        • qObjects array of objects
          Show qObjects properties
          • qId string
          • qActive boolean
          • qShowMode integer

            format = byte

          • qScrollPos object
            Show qScrollPos properties
            • qUsePosition boolean
            • qPos object
              Show qPos properties
              • qx integer

                x-coordinate in pixels. The origin is the top left of the screen.

                format = int32

              • qy integer

                y-coordinate in pixels. The origin is the top left of the screen.

                format = int32

        • qApplyLayoutState boolean

          default = false

        • qShowPopupInfo boolean

          default = false

        • qInfoText string
        • qOwner string
        • qGroups array of objects
          Show qGroups properties
          • qId string
          • qCyclePos integer

            format = int32

        • qShow object
          Show qShow properties
          • qAlways boolean

            default = true

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
        • qApplyInputFieldValues boolean

          default = true

        • qInputFieldItems array of objects
          Show qInputFieldItems properties
          • qFieldName string
          • qValues array of objects
            Show qValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qPackedHashKeys array of integers
        • qObjectsLayout array of objects
          Show qObjectsLayout properties
          • qId string
          • qActive boolean
          • qShowMode integer

            format = byte

          • qScrollPos object
            Show qScrollPos properties
            • qUsePosition boolean
            • qPos object
              Show qPos properties
              • qx integer

                x-coordinate in pixels. The origin is the top left of the screen.

                format = int32

              • qy integer

                y-coordinate in pixels. The origin is the top left of the screen.

                format = int32

          • qExpansionInfo array of objects
            Show qExpansionInfo properties
            • qExcludeList boolean
            • qPos object
              Show qPos properties
              • qDimName string
              • qElemNo array of integers
              • qElemValues array of strings
          • qLeftCollapsed boolean
          • qTopCollapsed boolean
          • qSortData array of objects
            Show qSortData properties
            • qName string
            • qReversed boolean
          • qDimensionGroupPos array of objects
            Show qDimensionGroupPos properties
            • qGroupName string
            • qCurrentItemName string
          • qExpressionGroupPos array of objects
            Show qExpressionGroupPos properties
            • qGroupName string
            • qCurrentItemName string
          • qUseGraphMode boolean
          • qGraphMode string

            Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"

          • qActiveContainerChildObjectId string
          • qExtendedPivotState object
            Show qExtendedPivotState properties
            • qExpressionPosition integer

              format = byte

            • qNumberOfLeftDimensions integer

              format = byte

            • qDimensionNames array of strings
            • qEnableConditions array of strings
        • qIncludeSelectionState boolean

          default = true

        • qIncludeScrollPosition boolean
        • qAlternateStateData array of objects
          Show qAlternateStateData properties
          • qStateName string

            Name of the alternate state. Default is current selections: $

          • qFieldItems array of objects

            List of the selections.

            Show qFieldItems properties
            • qDef object
              Show qDef properties
              • qName string

                Name of the field.

              • qType string

                Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

            • qLocked boolean

              Indicates if the field is locked. Default is false.

            • qSelectInfo object
              Show qSelectInfo properties
              • qTextSearch string

                Text search string. Everything that matches the text is selected. This parameter is optional.

              • qRangeLo number

                Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qNumberFormat object

                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:

                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.

                Show qNumberFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRangeInfo array of objects

                This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

                Show qRangeInfo properties
                • qRangeLo number

                  Lowest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qRangeHi number

                  Highest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qMeasure string

                  Label of the measure.
              • qSoftLock boolean

                Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

                default = false

              • qContinuousRangeInfo array of objects

                List of information about ranges for selections.

                Show qContinuousRangeInfo properties
                • qMin number

                  Lowest value in the range

                  format = double

                • qMax number

                  Highest value in the range

                  format = double

                • qMinInclEq boolean

                  If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

                • qMaxInclEq boolean

                  If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
              • qSelectFieldSearch boolean

                This parameter is true if the TextSearch is a result of a Select Field operation.

                default = false

            • qValues array of objects
              Show qValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qExcludedValues array of objects

              List of excluded values. Either the list of selected values or the list of excluded values is displayed.

              Show qExcludedValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qAndMode boolean

              If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

            • qOneAndOnlyOne boolean

              If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

            • qValuesCount integer

              Count of selected values. Indicates if the Values field is loaded.

              default = -1, format = int32, default = -1

            • qExcludedValuesCount integer

              Count of excluded values. Indicates if the ExcludedValues field is loaded.

              default = -1, format = int32, default = -1

        • qForAnnotations boolean
        • qIncludeAllVariables boolean

          default = false

      • qClassicMetadata object
        Show qClassicMetadata properties
        • qShared boolean
        • qUtcModifyTime number

          format = double

        • qSheetId string
        • qTemporary boolean
        • qRestrictedAccess boolean
        • qAccessList array of strings
        • qPersonalEditionHash_OBSOLETE string
        • qHidden boolean

          default = false

        • qLinkedTo array of strings
  • qEmbeddedSnapshotRef object
    Show qEmbeddedSnapshotRef properties
    • qProperties object
      Show qProperties properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qMetaDef object

        Used to collect metadata.

        Properties

        Semantic type with an empty structure.

      • qIncludeVariables boolean
        Experimental

        If true all variables will be stored in the bookmark.

        default = false

      • qDistinctValues boolean
        Experimental

        If true all selected values will be stored distinct, i.e. searchstrings will not be kept.

        default = false

    • qBookmark object
      Show qBookmark properties
      • qStateData array of objects

        List of selections for each state.

        Show qStateData properties
        • qStateName string

          Name of the alternate state. Default is current selections: $

        • qFieldItems array of objects

          List of the selections.

          Show qFieldItems properties
          • qDef object
            Show qDef properties
            • qName string

              Name of the field.

            • qType string

              Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

          • qLocked boolean

            Indicates if the field is locked. Default is false.

          • qSelectInfo object
            Show qSelectInfo properties
            • qTextSearch string

              Text search string. Everything that matches the text is selected. This parameter is optional.

            • qRangeLo number

              Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qNumberFormat object

              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:

              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.

              Show qNumberFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRangeInfo array of objects

              This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

              Show qRangeInfo properties
              • qRangeLo number

                Lowest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qMeasure string

                Label of the measure.
            • qSoftLock boolean

              Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

              default = false

            • qContinuousRangeInfo array of objects

              List of information about ranges for selections.

              Show qContinuousRangeInfo properties
              • qMin number

                Lowest value in the range

                format = double

              • qMax number

                Highest value in the range

                format = double

              • qMinInclEq boolean

                If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

              • qMaxInclEq boolean

                If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
            • qSelectFieldSearch boolean

              This parameter is true if the TextSearch is a result of a Select Field operation.

              default = false

          • qValues array of objects
            Show qValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qExcludedValues array of objects

            List of excluded values. Either the list of selected values or the list of excluded values is displayed.

            Show qExcludedValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qAndMode boolean

            If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

          • qOneAndOnlyOne boolean

            If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

          • qValuesCount integer

            Count of selected values. Indicates if the Values field is loaded.

            default = -1, format = int32, default = -1

          • qExcludedValuesCount integer

            Count of excluded values. Indicates if the ExcludedValues field is loaded.

            default = -1, format = int32, default = -1

      • qUtcModifyTime number

        Time when the bookmark was created.

        format = double

      • qVariableItems array of objects

        List of the variables in the app at the time the bookmark was created.

        Show qVariableItems properties
        • qName string

          Name of the variable.

        • qValue object
          Show qValue properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qDefinition string

          The Reporting mode definition of the variable.
      • qPatches array of objects

        Softpatches to be applied with this bookmark.

        Show qPatches properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qPatches array of objects

          Array with patches.

          Show qPatches properties
          • qOp string

            Can be one of: "add""remove""replace"

          • qPath string

            Path to the property to add, remove or replace.

          • qValue string

            This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
        • qChildren array of undefineds

          Array with child objects and their patches.
      • qCyclicGroupStates array of objects

        Information about cyclic groups by zero-based index. This field is unused.

        Show qCyclicGroupStates properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qActiveField integer

          Active field of the cyclic group, identified by a zero-based index.

          format = int32

      • qGroupStates array of objects
        Experimental

        Information about cyclic groups indexed by field definition.

        Show qGroupStates properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qActiveFieldDef string

          String defining the active field.
    • qClassicBookmark object
      Show qClassicBookmark properties
      • qId string
      • qName string
      • qUtcModifyTime number

        format = double

      • qUtcRecallTime number

        format = double

      • qRecallCount integer

        format = int32

      • qApplyAdditive boolean
      • qFieldItems array of objects
        Show qFieldItems properties
        • qDef object
          Show qDef properties
          • qName string

            Name of the field.

          • qType string

            Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

        • qLocked boolean

          Indicates if the field is locked. Default is false.

        • qSelectInfo object
          Show qSelectInfo properties
          • qTextSearch string

            Text search string. Everything that matches the text is selected. This parameter is optional.

          • qRangeLo number

            Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

            default = -1e+300, format = double, default = -1e+300

          • qRangeHi number

            Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

            default = -1e+300, format = double, default = -1e+300

          • qNumberFormat object

            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:

            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.

            Show qNumberFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRangeInfo array of objects

            This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

            Show qRangeInfo properties
            • qRangeLo number

              Lowest value in the range.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value in the range.

              default = -1e+300, format = double, default = -1e+300

            • qMeasure string

              Label of the measure.
          • qSoftLock boolean

            Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

            default = false

          • qContinuousRangeInfo array of objects

            List of information about ranges for selections.

            Show qContinuousRangeInfo properties
            • qMin number

              Lowest value in the range

              format = double

            • qMax number

              Highest value in the range

              format = double

            • qMinInclEq boolean

              If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

            • qMaxInclEq boolean

              If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
          • qSelectFieldSearch boolean

            This parameter is true if the TextSearch is a result of a Select Field operation.

            default = false

        • qValues array of objects
          Show qValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qExcludedValues array of objects

          List of excluded values. Either the list of selected values or the list of excluded values is displayed.

          Show qExcludedValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qAndMode boolean

          If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

        • qOneAndOnlyOne boolean

          If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

        • qValuesCount integer

          Count of selected values. Indicates if the Values field is loaded.

          default = -1, format = int32, default = -1

        • qExcludedValuesCount integer

          Count of excluded values. Indicates if the ExcludedValues field is loaded.

          default = -1, format = int32, default = -1

      • qVariableItems array of objects
        Show qVariableItems properties
        • qName string

          Name of the variable.

        • qValue object
          Show qValue properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qDefinition string

          The Reporting mode definition of the variable.
      • qSheetId string
      • qObjects array of objects
        Show qObjects properties
        • qId string
        • qActive boolean
        • qShowMode integer

          format = byte

        • qScrollPos object
          Show qScrollPos properties
          • qUsePosition boolean
          • qPos object
            Show qPos properties
            • qx integer

              x-coordinate in pixels. The origin is the top left of the screen.

              format = int32

            • qy integer

              y-coordinate in pixels. The origin is the top left of the screen.

              format = int32

      • qApplyLayoutState boolean

        default = false

      • qShowPopupInfo boolean

        default = false

      • qInfoText string
      • qOwner string
      • qGroups array of objects
        Show qGroups properties
        • qId string
        • qCyclePos integer

          format = int32

      • qShow object
        Show qShow properties
        • qAlways boolean

          default = true

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
      • qApplyInputFieldValues boolean

        default = true

      • qInputFieldItems array of objects
        Show qInputFieldItems properties
        • qFieldName string
        • qValues array of objects
          Show qValues properties
          • qText string

            Text related to the field value. This parameter is optional.

          • qIsNumeric boolean

            Is set to true if the value is a numeric. This parameter is optional. Default is false.

          • qNumber number

            Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

            format = double

        • qPackedHashKeys array of integers
      • qObjectsLayout array of objects
        Show qObjectsLayout properties
        • qId string
        • qActive boolean
        • qShowMode integer

          format = byte

        • qScrollPos object
          Show qScrollPos properties
          • qUsePosition boolean
          • qPos object
            Show qPos properties
            • qx integer

              x-coordinate in pixels. The origin is the top left of the screen.

              format = int32

            • qy integer

              y-coordinate in pixels. The origin is the top left of the screen.

              format = int32

        • qExpansionInfo array of objects
          Show qExpansionInfo properties
          • qExcludeList boolean
          • qPos object
            Show qPos properties
            • qDimName string
            • qElemNo array of integers
            • qElemValues array of strings
        • qLeftCollapsed boolean
        • qTopCollapsed boolean
        • qSortData array of objects
          Show qSortData properties
          • qName string
          • qReversed boolean
        • qDimensionGroupPos array of objects
          Show qDimensionGroupPos properties
          • qGroupName string
          • qCurrentItemName string
        • qExpressionGroupPos array of objects
          Show qExpressionGroupPos properties
          • qGroupName string
          • qCurrentItemName string
        • qUseGraphMode boolean
        • qGraphMode string

          Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"

        • qActiveContainerChildObjectId string
        • qExtendedPivotState object
          Show qExtendedPivotState properties
          • qExpressionPosition integer

            format = byte

          • qNumberOfLeftDimensions integer

            format = byte

          • qDimensionNames array of strings
          • qEnableConditions array of strings
      • qIncludeSelectionState boolean

        default = true

      • qIncludeScrollPosition boolean
      • qAlternateStateData array of objects
        Show qAlternateStateData properties
        • qStateName string

          Name of the alternate state. Default is current selections: $

        • qFieldItems array of objects

          List of the selections.

          Show qFieldItems properties
          • qDef object
            Show qDef properties
            • qName string

              Name of the field.

            • qType string

              Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

          • qLocked boolean

            Indicates if the field is locked. Default is false.

          • qSelectInfo object
            Show qSelectInfo properties
            • qTextSearch string

              Text search string. Everything that matches the text is selected. This parameter is optional.

            • qRangeLo number

              Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qNumberFormat object

              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:

              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.

              Show qNumberFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRangeInfo array of objects

              This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

              Show qRangeInfo properties
              • qRangeLo number

                Lowest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qMeasure string

                Label of the measure.
            • qSoftLock boolean

              Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

              default = false

            • qContinuousRangeInfo array of objects

              List of information about ranges for selections.

              Show qContinuousRangeInfo properties
              • qMin number

                Lowest value in the range

                format = double

              • qMax number

                Highest value in the range

                format = double

              • qMinInclEq boolean

                If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

              • qMaxInclEq boolean

                If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
            • qSelectFieldSearch boolean

              This parameter is true if the TextSearch is a result of a Select Field operation.

              default = false

          • qValues array of objects
            Show qValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qExcludedValues array of objects

            List of excluded values. Either the list of selected values or the list of excluded values is displayed.

            Show qExcludedValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qAndMode boolean

            If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

          • qOneAndOnlyOne boolean

            If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

          • qValuesCount integer

            Count of selected values. Indicates if the Values field is loaded.

            default = -1, format = int32, default = -1

          • qExcludedValuesCount integer

            Count of excluded values. Indicates if the ExcludedValues field is loaded.

            default = -1, format = int32, default = -1

      • qForAnnotations boolean
      • qIncludeAllVariables boolean

        default = false

    • qClassicMetadata object
      Show qClassicMetadata properties
      • qShared boolean
      • qUtcModifyTime number

        format = double

      • qSheetId string
      • qTemporary boolean
      • qRestrictedAccess boolean
      • qAccessList array of strings
      • qPersonalEditionHash_OBSOLETE string
      • qHidden boolean

        default = false

      • qLinkedTo array of strings

schemas GenericObjectLayout object

Is the layout for GenericObjectProperties.

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qExtendsId string

    Should be set to create an object that is linked to another object. Enter the identifier of the object you want to link to. If you do not want to link your object, set this parameter to an empty string.

  • qHasSoftPatches boolean

    Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied).

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code.

      format = int32

  • qSelectionInfo object
    Show qSelectionInfo properties
    • qInSelections boolean

      Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections Method.

    • qMadeSelections boolean

      Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see BeginSelections Method.
  • qStateName string

    Name of the alternate state. Default is current selections $ .

  • qAppObjectList object

    Lists the app objects. Is the layout for AppObjectListDef.

    An app object is a generic object created at app level.
    Show qAppObjectList properties
    • qItems array of objects

      Information about the list of dimensions.

      Show qItems properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qMeta object

        Layout for NxMetaDef.

        Show qMeta properties
        • qName string

          Name. This property is optional.
      • qData object

        Contains dynamic JSON data specified by the client.
  • qBookmarkList object

    Lists the bookmarks. Is the layout for BookmarkListDef.

    Show qBookmarkList properties
    • qItems array of objects

      Information about the list of bookmarks.

      Show qItems properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qMeta object

        Layout for NxMetaDef.

        Show qMeta properties
        • qName string

          Name. This property is optional.
      • qData object

        Contains dynamic JSON data specified by the client.
  • qChildList object

    Lists the children of a generic object. Is the layout for ChildListDef.

    ChildList is used by the _GetLayout Method_ to list the children of a generic object.
    Show qChildList properties
    • qItems array of objects

      Information about the items in the app object.

      Show qItems properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qMeta object

        Layout for NxMetaDef.

        Show qMeta properties
        • qName string

          Name. This property is optional.
      • qData object

        Contains dynamic JSON data specified by the client.
  • qDimensionList object

    Lists the dimensions. Is the layout for DimensionListDef.

    Show qDimensionList properties
    • qItems array of objects

      Information about the list of dimensions.

      Show qItems properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qMeta object

        Layout for NxMetaDef.

        Show qMeta properties
        • qName string

          Name. This property is optional.
      • qData object

        Contains dynamic JSON data specified by the client.
  • qEmbeddedSnapshot object

    Renders the embedded snapshot in an object. The following is returned:

    • Any dynamic properties defined in the bookmark
    • Any properties defined in qEmbeddedSnapshot

    Properties

    "qEmbeddedSnapshot": {}

  • qExtensionList object

    Obsolete, use qrs API's to fetch extensions.

    Show qExtensionList properties
    • qItems array of strings
  • qFieldList object

    Lists the fields present in the data model viewer. Is the layout for FieldListDef.

    Show qFieldList properties
    • qItems array of objects

      Array of items.

      Show qItems properties
      • qIsSemantic boolean

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

      • qIsHidden boolean

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

      • qIsSystem boolean

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

      • qAndMode boolean

        If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.

      • qName string

        Name of the field

      • qCardinal integer

        Number of distinct field values

        format = int32

      • qTags array of strings

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

      • qIsDefinitionOnly boolean

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

      • qDerivedFieldData object
        Show qDerivedFieldData properties
        • qDerivedFieldLists array of objects

          Information about the derived fields.

          Show qDerivedFieldLists properties
          • qDerivedDefinitionName string

            Name of the derived definition.

          • qFieldDefs array of objects

            List of the derived fields.

            Show qFieldDefs properties
            • qId string

              Identifier of the derived field. The identifier is unique.

            • qName string

              Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year

            • qMethod string

              Method name associated to the derived field.

            • qExpr string

              Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year , the expression is as follows: =${Mydefinition(OrderDate).Year}

            • qTags array of strings

              List of tags.
          • qGroupDefs array of objects

            List of the derived groups.

            Show qGroupDefs properties
            • qId string

              Identifier of the group.

            • qName string

              Name of the derived group.

            • qGrouping string

              Can be one of: "N""H""C"

            • qFieldDefs array of strings

              List of the derived fields in the group.
          • qTags array of strings

            List of tags on the derived fields.
      • qIsDetail boolean

        Is used for Direct Discovery. If set to true, it means that the type of the field is detail.

      • qIsImplicit boolean

        Is used for Direct Discovery. If set to true, it means that the type of the field is measure.

      • qReadableName string
  • qHyperCube object

    Renders the properties of a hypercube. Is the layout for HyperCubeDef. For more information about the definition of a hypercube, see Generic object.

    What is returned in HyperCube depends on the type of the hypercube (straight, pivot or stacked table, or tree) and on the method called (GetLayout, GetHyperCubeData, GetHyperCubePivotData, GetHyperCubeStackData, GetHyperCubeTreeData).
    Show qHyperCube properties
    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qSize object
      Show qSize properties
      • qcx integer

        Number of pixels on the x axis.

        format = int32

      • qcy integer

        Number of pixels on the y axis.

        format = int32

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qDimensionInfo array of objects

      Information on the dimension.

      Show qDimensionInfo properties
      • qFallbackTitle string

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

      • qApprMaxGlyphCount integer

        Length of the longest value in the field.

        format = int32

      • qCardinal integer Deprecated

        Number of distinct field values.

        format = int32

      • qLocked boolean

        Is set to true if the field is locked.

      • qSortIndicator string

        Can be one of: "N""A""D"

      • qGroupFallbackTitles array of strings

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

      • qGroupPos integer

        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.

        format = int32

      • qStateCounts object
        Show qStateCounts properties
        • qLocked integer

          Number of values in locked state.

          format = int32

        • qSelected integer

          Number of values in selected state.

          format = int32

        • qOption integer

          Number of values in optional state.

          format = int32

        • qDeselected integer

          Number of values in deselected state.

          format = int32

        • qAlternative integer

          Number of values in alternative state.

          format = int32

        • qExcluded integer

          Number of values in excluded state.

          format = int32

        • qSelectedExcluded integer

          Number of values in selected excluded state.

          format = int32

        • qLockedExcluded integer

          Number of values in locked excluded state.

          format = int32

      • qTags array of strings

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

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qDimensionType string

        Can be one of: "D""N""T"

      • qReverseSort boolean

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

      • qGrouping string

        Can be one of: "N""H""C"

      • qIsSemantic boolean

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

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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.

      • qGroupFieldDefs array of strings

        Array of field names.

      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qContinuousAxes boolean

        Is continuous axis used.

      • qIsCyclic boolean

        Is a cyclic dimension used.

      • qDerivedField boolean

        Is derived field is used as a dimension.

      • qAttrExprInfo array of objects

        Array of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qAttrDimInfo array of objects

        Array of attribute dimensions.

        Show qAttrDimInfo properties
        • qCardinal integer

          Cardinality of the attribute expression.

          format = int32

        • qSize object
          Show qSize properties
          • qcx integer

            Number of pixels on the x axis.

            format = int32

          • qcy integer

            Number of pixels on the y axis.

            format = int32

        • qFallbackTitle string

          The title for the attribute dimension.

        • qLocked boolean

          The Locked value of the dimension.

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

      • qCalcCondMsg string

        The message displayed if calculation condition is not fulfilled.

      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

      • qIsOneAndOnlyOne boolean

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

      • qCardinalities object
        Show qCardinalities properties
        • qCardinal integer

          Number of distinct field values.

          format = int32

        • qHypercubeCardinal integer

          Number of distinct hypercube values.

          format = int32

        • qAllValuesCardinal integer

          Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

          default = -1, format = int32, default = -1

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qEffectiveDimensionName string
        Experimental

        The expanded and stripped dimension name used internally in engine.
    • qMeasureInfo array of objects

      Information on the measure.

      Show qMeasureInfo properties
      • qFallbackTitle string

        Corresponds to the label of the measure. If the label is not defined then the measure name is used.

      • qApprMaxGlyphCount integer

        Length of the longest value in the field.

        format = int32

      • qCardinal integer

        Number of distinct field values.

        format = int32

      • qSortIndicator string

        Can be one of: "N""A""D"

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qMin number

        Lowest value in the range.

        format = double

      • qMax number

        Highest value in the range.

        format = double

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qReverseSort boolean

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

      • 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 expression.

      • qAttrExprInfo array of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qAttrDimInfo array of objects

        List of attribute dimensions.

        Show qAttrDimInfo properties
        • qCardinal integer

          Cardinality of the attribute expression.

          format = int32

        • qSize object
          Show qSize properties
          • qcx integer

            Number of pixels on the x axis.

            format = int32

          • qcy integer

            Number of pixels on the y axis.

            format = int32

        • qFallbackTitle string

          The title for the attribute dimension.

        • qLocked boolean

          The Locked value of the dimension.

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

      • qCalcCondMsg string

        The message displayed if calculation condition is not fulfilled.

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qTrendLines array of objects
        Experimental

        Calculated trendlines

        Show qTrendLines properties
        • qType string

          Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qCoeff array of numbers

          Coefficent c0..cN depending on the trendline type.

        • qR2 number

          R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

          format = double

        • qExpression string

          Trendline expression

        • qElemNo integer

          Inner Dim elem no

          format = int32

      • qMiniChart object
        Show qMiniChart properties
        • qYMin number

          format = double

        • qYMax number

          format = double

        • qXMin number

          format = double

        • qXMax number

          format = double

        • qAttrExprInfo array of objects

          List of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • 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 expression.
        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
    • qEffectiveInterColumnSortOrder array of integers

      Sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted was the column 1, followed by the column 0 and the column 2.

    • qGrandTotalRow array of objects

      Aggregate for measures of all values in the field. The result value depends on the qAggrFunc defined in HyperCubeDef.

      Show qGrandTotalRow properties
      • qText string

        Some text. This parameter is optional.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmpty boolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCell boolean

        Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

      • qIsOtherCell boolean

        Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

      • qFrequency string

        Frequency of the value. This parameter is optional.

      • qHighlightRanges object
        Show qHighlightRanges properties
        • qRanges array of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPos integer

            Position of the first search occurrence.

            format = int32

          • qCharCount integer

            Number of occurrences found.

            format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qIsNull boolean

        Is set to true if the value is Null.

      • qMiniChart object
        Show qMiniChart properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

        • qMin number

          format = double

        • qMax number

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
      • qInExtRow boolean
    • qDataPages array of objects

      Set of data. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

      Show qDataPages properties
      • qMatrix array of arrays

        Array of data.

        Show qMatrix properties
        • qText string

          Some text. This parameter is optional.

        • qNum number

          A value. This parameter is optional.

          format = double

        • qElemNumber integer

          Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

          • -1: the cell is a Total cell. It shows a total.
          • -2: the cell is a Null cell.
          • -3: the cell belongs to the group Others .
          • -4: the cell is empty. Applies to pivot tables.

          format = int32

        • qState string

          Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

        • qIsEmpty boolean

          Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

        • qIsTotalCell boolean

          Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

        • qIsOtherCell boolean

          Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

        • qFrequency string

          Frequency of the value. This parameter is optional.

        • qHighlightRanges object
          Show qHighlightRanges properties
          • qRanges array of objects

            Ranges of highlighted values.

            Show qRanges properties
            • qCharPos integer

              Position of the first search occurrence.

              format = int32

            • qCharCount integer

              Number of occurrences found.

              format = int32

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

        • qIsNull boolean

          Is set to true if the value is Null.

        • qMiniChart object
          Show qMiniChart properties
          • qMatrix array of arrays

            Array of data.

            Show qMatrix properties
            • qText string

              Some text.

            • qNum number

              A value. This parameter is optional.

              format = double

            • qElemNumber integer

              Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

              • -1: the cell is a Total cell. It shows a total.
              • -2: the cell is a Null cell.
              • -3: the cell belongs to the group Others .
              • -4: the cell is empty. Applies to pivot tables.

              format = int32

            • qAttrExps object
              Show qAttrExps properties
              • qValues array of objects

                List of attribute expressions values.

                Show qValues properties
                • qText string

                  Text related to the attribute expression value.

                • qNum number

                  Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                  format = double

          • qMin number

            format = double

          • qMax number

            format = double

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
        • qInExtRow boolean
      • qTails array of objects

        Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

        Show qTails properties
        • qUp integer

          Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

          format = int32

        • qDown integer

          Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

          format = int32

      • qArea object
        Show qArea properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qIsReduced boolean

        Is set to true, if the data have been reduced. The default value is false.

        default = false

    • qPivotDataPages array of objects

      Set of data for pivot tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

      Show qPivotDataPages properties
      • qLeft array of objects

        Information about the left dimension values of a pivot table.

        Show qLeft properties
        • qText string

          Some text.

        • qElemNo integer

          Rank number of the value. If set to -1, it means that the value is not an element number.

          format = int32

        • qValue number

          Value of the cell. Is set to NaN , if the value is not a number.

          format = double

        • qCanExpand boolean

          If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

        • qCanCollapse boolean

          If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

        • qType string

          Can be one of: "V""E""N""T""O""A""P""R""U""G"

        • qUp integer

          Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

          format = int32

        • qDown integer

          Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

          format = int32

        • qSubNodes array of undefineds

          Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

      • qTop array of objects

        Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.

        Show qTop properties
        • qText string

          Some text.

        • qElemNo integer

          Rank number of the value. If set to -1, it means that the value is not an element number.

          format = int32

        • qValue number

          Value of the cell. Is set to NaN , if the value is not a number.

          format = double

        • qCanExpand boolean

          If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

        • qCanCollapse boolean

          If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

        • qType string

          Can be one of: "V""E""N""T""O""A""P""R""U""G"

        • qUp integer

          Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

          format = int32

        • qDown integer

          Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

          format = int32

        • qSubNodes array of undefineds

          Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

      • qData array of arrays

        Array of data.

        Show qData properties
        • qLabel string

          Label of the cell. This parameter is optional.

        • qText string

          Some text related to the cell.

        • qNum number

          Value of the cell.

          format = double

        • qType string

          Can be one of: "V""E""N""T""O""A""P""R""U""G"

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

      • qArea object
        Show qArea properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

    • qStackedDataPages array of objects

      Set of data for stacked tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

      Show qStackedDataPages properties
      • qData array of objects

        Array of data.

        Show qData properties
        • qText string

          Some text.

        • qElemNo integer

          Rank number of the value. If set to -1, it means that the value is not an element number.

          format = int32

        • qValue number

          Value of the cell. Is set to NaN , if the value is not a number.

          format = double

        • qCanExpand boolean

          If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

        • qCanCollapse boolean

          If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

        • qType string

          Can be one of: "V""E""N""T""O""A""P""R""U""G"

        • qMaxPos number

          Total of the positive values in the current group of cells.

          format = double

        • qMinNeg number

          Total of the negative values in the current group of cells.

          format = double

        • qUp integer

          Number of elements that are part of the previous tail.

          format = int32

        • qDown integer

          Number of elements that are part of the next tail.

          format = int32

        • qRow integer

          Row index in the data matrix. The indexing starts from 0.

          format = int32

        • qSubNodes array of undefineds

          Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

      • qArea object
        Show qArea properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

    • qMode string

      Can be one of: "S""P""K""T""D"

    • qNoOfLeftDims integer

      Number of left dimensions. Default value is -1. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

      • Four dimensions in the following order: Country, City, Product and Category
      • One pseudo dimension in position 1
      • Three left dimensions.

      implies that:

      • The index 0 corresponds to the left dimension Country.
      • The index 1 corresponds to the pseudo dimension.
      • The index 2 corresponds to the left dimension City.
      • Product and Category are top dimensions.

      Another example:

      • Four dimensions in the following order: Country, City, Product and Category.
      • One pseudo dimension in position -1.
      • Three left dimensions.

      implies that:

      • The index -1 corresponds to the pseudo dimension; the pseudo dimension is the most to the right.
      • The index 0 corresponds to the left dimension Country.
      • The index 1 corresponds to the left dimension City.
      • The index 2 corresponds to the left dimension Product.
      • Category is a top dimension.

      format = int32

    • qIndentMode boolean

      Is used for pivot tables only. If set to true, the formatting of the results is slightly different. This property is optional.

    • qLastExpandedPos object
      Show qLastExpandedPos properties
      • qx integer

        Position of the cell on the x-axis.

        format = int32

      • qy integer

        Position of the cell on the y-axis.

        format = int32

    • qHasOtherValues boolean

      True if other row exists.

    • qTitle string

      Title of the hypercube, for example the title of a chart.

    • qTreeNodesOnDim array of integers

      The total number of nodes on each dimension (only applicable when qMode = T ).

    • qCalcCondMsg string

      The message displayed if calculation condition is not fulfilled.

    • qColumnOrder array of integers

      The order of the columns.
  • qListObject object

    Renders the properties of a list object. Is the layout for ListObjectDef. For more information about the definition of a list object, see Generic object.

    ListObject is used by the _GetLayout Method_ to display the properties of a list object.
    Show qListObject properties
    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qSize object
      Show qSize properties
      • qcx integer

        Number of pixels on the x axis.

        format = int32

      • qcy integer

        Number of pixels on the y axis.

        format = int32

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qDimensionInfo object
      Show qDimensionInfo properties
      • qFallbackTitle string

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

      • qApprMaxGlyphCount integer

        Length of the longest value in the field.

        format = int32

      • qCardinal integer Deprecated

        Number of distinct field values.

        format = int32

      • qLocked boolean

        Is set to true if the field is locked.

      • qSortIndicator string

        Can be one of: "N""A""D"

      • qGroupFallbackTitles array of strings

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

      • qGroupPos integer

        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.

        format = int32

      • qStateCounts object
        Show qStateCounts properties
        • qLocked integer

          Number of values in locked state.

          format = int32

        • qSelected integer

          Number of values in selected state.

          format = int32

        • qOption integer

          Number of values in optional state.

          format = int32

        • qDeselected integer

          Number of values in deselected state.

          format = int32

        • qAlternative integer

          Number of values in alternative state.

          format = int32

        • qExcluded integer

          Number of values in excluded state.

          format = int32

        • qSelectedExcluded integer

          Number of values in selected excluded state.

          format = int32

        • qLockedExcluded integer

          Number of values in locked excluded state.

          format = int32

      • qTags array of strings

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

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qDimensionType string

        Can be one of: "D""N""T"

      • qReverseSort boolean

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

      • qGrouping string

        Can be one of: "N""H""C"

      • qIsSemantic boolean

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

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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.

      • qGroupFieldDefs array of strings

        Array of field names.

      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qContinuousAxes boolean

        Is continuous axis used.

      • qIsCyclic boolean

        Is a cyclic dimension used.

      • qDerivedField boolean

        Is derived field is used as a dimension.

      • qAttrExprInfo array of objects

        Array of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qAttrDimInfo array of objects

        Array of attribute dimensions.

        Show qAttrDimInfo properties
        • qCardinal integer

          Cardinality of the attribute expression.

          format = int32

        • qSize object
          Show qSize properties
          • qcx integer

            Number of pixels on the x axis.

            format = int32

          • qcy integer

            Number of pixels on the y axis.

            format = int32

        • qFallbackTitle string

          The title for the attribute dimension.

        • qLocked boolean

          The Locked value of the dimension.

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

      • qCalcCondMsg string

        The message displayed if calculation condition is not fulfilled.

      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

      • qIsOneAndOnlyOne boolean

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

      • qCardinalities object
        Show qCardinalities properties
        • qCardinal integer

          Number of distinct field values.

          format = int32

        • qHypercubeCardinal integer

          Number of distinct hypercube values.

          format = int32

        • qAllValuesCardinal integer

          Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

          default = -1, format = int32, default = -1

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qEffectiveDimensionName string
        Experimental

        The expanded and stripped dimension name used internally in engine.
    • qExpressions array of objects

      Lists the expressions in the list object.

      Show qExpressions properties
      • qExpr string

        Value of the expression.

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code.

          format = int32

    • qDataPages array of objects

      Set of data. Is empty if nothing has been defined in qInitialDataFetch in ListObjectDef.

      Show qDataPages properties
      • qMatrix array of arrays

        Array of data.

        Show qMatrix properties
        • qText string

          Some text. This parameter is optional.

        • qNum number

          A value. This parameter is optional.

          format = double

        • qElemNumber integer

          Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

          • -1: the cell is a Total cell. It shows a total.
          • -2: the cell is a Null cell.
          • -3: the cell belongs to the group Others .
          • -4: the cell is empty. Applies to pivot tables.

          format = int32

        • qState string

          Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

        • qIsEmpty boolean

          Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

        • qIsTotalCell boolean

          Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

        • qIsOtherCell boolean

          Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

        • qFrequency string

          Frequency of the value. This parameter is optional.

        • qHighlightRanges object
          Show qHighlightRanges properties
          • qRanges array of objects

            Ranges of highlighted values.

            Show qRanges properties
            • qCharPos integer

              Position of the first search occurrence.

              format = int32

            • qCharCount integer

              Number of occurrences found.

              format = int32

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

        • qIsNull boolean

          Is set to true if the value is Null.

        • qMiniChart object
          Show qMiniChart properties
          • qMatrix array of arrays

            Array of data.

            Show qMatrix properties
            • qText string

              Some text.

            • qNum number

              A value. This parameter is optional.

              format = double

            • qElemNumber integer

              Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

              • -1: the cell is a Total cell. It shows a total.
              • -2: the cell is a Null cell.
              • -3: the cell belongs to the group Others .
              • -4: the cell is empty. Applies to pivot tables.

              format = int32

            • qAttrExps object
              Show qAttrExps properties
              • qValues array of objects

                List of attribute expressions values.

                Show qValues properties
                • qText string

                  Text related to the attribute expression value.

                • qNum number

                  Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                  format = double

          • qMin number

            format = double

          • qMax number

            format = double

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
        • qInExtRow boolean
      • qTails array of objects

        Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

        Show qTails properties
        • qUp integer

          Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

          format = int32

        • qDown integer

          Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

          format = int32

      • qArea object
        Show qArea properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qIsReduced boolean

        Is set to true, if the data have been reduced. The default value is false.

        default = false

  • qMeasureList object

    Lists the measures. Is the layout for MeasureListDef.

    Show qMeasureList properties
    • qItems array of objects

      Information about the list of measures.

      Show qItems properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qMeta object

        Layout for NxMetaDef.

        Show qMeta properties
        • qName string

          Name. This property is optional.
      • qData object

        Contains dynamic JSON data specified by the client.
  • qMediaList object

    Lists the media files. Is the layout for MediaListDef.

    This struct is deprecated.
    Show qMediaList properties
    • qItems array of objects

      Information about the list of media files. In Qlik Sense Desktop, the media files are retrieved from: %userprofile%\Documents\Qlik\Sense\Content\Default In Qlik Sense Enterprise, the media files are retrieved from: <installation_directory>\Qlik\Sense\Repository\Content\Default The default installation directory is ProgramData .

      Show qItems properties
      • qUrlDef string

        Relative path to the media file. The URL is static. Media files located:

        • in the /content/default/ folder are outside the qvf file.
        • in the /media/ folder are embedded in the qvf file.
      • qUrl string

        Relative path to the media file. Media files located:

        • in the /content/default/ folder are outside the qvf file.
        • in the /media/ folder are embedded in the qvf file.
  • qNxLibraryDimension object
    Show qNxLibraryDimension properties
    • qGrouping string

      Can be one of: "N""H""C"

    • qFieldDefs array of strings

      Array of dimension names.

    • qFieldLabels array of strings

      Array of dimension labels.

    • qLabelExpression string
    • qAlias string

      Alias of the dimension.

    • qScriptGenerated boolean Deprecated
    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

  • qNxLibraryMeasure object

    Information about the library measure. Is the layout for NxLibraryMeasureDef.

    Show qNxLibraryMeasure properties
    • qLabel string
    • qDef string
    • qGrouping string

      Can be one of: "N""H""C"

    • qExpressions array of strings
    • qActiveExpression integer

      format = int32

    • qLabelExpression string
    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qScriptGenerated boolean Deprecated
    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

  • qSelectionObject object

    Indicates which selections are currently applied. It gives the current selections. Is the layout for SelectionObjectDef.

    Show qSelectionObject properties
    • qBackCount integer

      Number of steps back.

      format = int32

    • qForwardCount integer

      Number of steps forward.

      format = int32

    • qSelections array of objects

      Lists the fields that are selected.

      Show qSelections properties
      • qTotal integer

        Number of values in the field.

        format = int32

      • qIsNum boolean

        This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional.

      • qField string

        Name of the field that is selected.

      • qLocked boolean

        This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional.

      • qOneAndOnlyOne boolean

        This parameter is displayed if its value is true. Property that is set to a field. Is set to true if the field cannot be unselected. This parameter is optional.

      • qTextSearch string

        Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional.

      • qSelectedCount integer

        Number of values that are selected.

        format = int32

      • qSelected string

        Values that are selected.

      • qRangeInfo array of objects

        Information about the range of selected values. Is empty if there is no range of selected values.

        Show qRangeInfo properties
        • qRangeLo number

          Lowest value in the range.

          default = -1e+300, format = double, default = -1e+300

        • qRangeHi number

          Highest value in the range.

          default = -1e+300, format = double, default = -1e+300

        • qMeasure string

          Label of the measure.
      • qSortIndex integer

        Sort index of the field. Indexing starts from 0.

        format = int32

      • qStateCounts object
        Show qStateCounts properties
        • qLocked integer

          Number of values in locked state.

          format = int32

        • qSelected integer

          Number of values in selected state.

          format = int32

        • qOption integer

          Number of values in optional state.

          format = int32

        • qDeselected integer

          Number of values in deselected state.

          format = int32

        • qAlternative integer

          Number of values in alternative state.

          format = int32

        • qExcluded integer

          Number of values in excluded state.

          format = int32

        • qSelectedExcluded integer

          Number of values in selected excluded state.

          format = int32

        • qLockedExcluded integer

          Number of values in locked excluded state.

          format = int32

      • qSelectedFieldSelectionInfo array of objects

        Information about the fields that are selected.

        Show qSelectedFieldSelectionInfo properties
        • qName string

          Name of the field.

        • qFieldSelectionMode string

          Can be one of: "NORMAL""AND""NOT"

      • qNotSelectedFieldSelectionInfo array of objects

        Information about the fields that are not selected.

        Show qNotSelectedFieldSelectionInfo properties
        • qName string

          Name of the field.

        • qFieldSelectionMode string

          Can be one of: "NORMAL""AND""NOT"

      • qSelectionThreshold integer

        Maximum values to show in the current selections. The default value is 6.

        format = int32

      • qReadableName string

        Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly.

      • qIsHidden boolean

        Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden.

      • qDimensionReferences array of objects
        Experimental

        List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem.

        Show qDimensionReferences properties
        • qId string

          Identifier of the associated dimension.

        • qLabel string

          Text label.
    • qStateName string

      Name of the alternate state. Default is current selections $ .
  • qStaticContentUrl object
    In addition, this structure can return dynamic properties.
    Show qStaticContentUrl properties
    • qUrl string

      Relative path of the thumbnail.
  • qTreeData object

    Renders the properties of a TreeData object. Is the layout for TreeDataDef. For more information about the definition of TreeData, see Generic object.

    To retrieve data from the TreeData object, use the method called GetHyperCubeTreeData.
    Show qTreeData properties
    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qNodesOnDim array of integers

      The total number of nodes on each dimension.

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qDimensionInfo array of objects

      Information on the dimension.

      Show qDimensionInfo properties
      • qFallbackTitle string

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

      • qApprMaxGlyphCount integer

        Length of the longest value in the field.

        format = int32

      • qCardinal integer Deprecated

        Number of distinct field values.

        format = int32

      • qLocked boolean

        Is set to true if the field is locked.

      • qSortIndicator string

        Can be one of: "N""A""D"

      • qGroupFallbackTitles array of strings

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

      • qGroupPos integer

        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.

        format = int32

      • qStateCounts object
        Show qStateCounts properties
        • qLocked integer

          Number of values in locked state.

          format = int32

        • qSelected integer

          Number of values in selected state.

          format = int32

        • qOption integer

          Number of values in optional state.

          format = int32

        • qDeselected integer

          Number of values in deselected state.

          format = int32

        • qAlternative integer

          Number of values in alternative state.

          format = int32

        • qExcluded integer

          Number of values in excluded state.

          format = int32

        • qSelectedExcluded integer

          Number of values in selected excluded state.

          format = int32

        • qLockedExcluded integer

          Number of values in locked excluded state.

          format = int32

      • qTags array of strings

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

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qDimensionType string

        Can be one of: "D""N""T"

      • qReverseSort boolean

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

      • qGrouping string

        Can be one of: "N""H""C"

      • qIsSemantic boolean

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

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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.

      • qGroupFieldDefs array of strings

        Array of field names.

      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qContinuousAxes boolean

        Is continuous axis used.

      • qIsCyclic boolean

        Is a cyclic dimension used.

      • qDerivedField boolean

        Is derived field is used as a dimension.

      • qMeasureInfo array of objects

        A List of measures to be calculated on this TreeDimension.

        Show qMeasureInfo properties
        • qFallbackTitle string

          Corresponds to the label of the measure. If the label is not defined then the measure name is used.

        • qApprMaxGlyphCount integer

          Length of the longest value in the field.

          format = int32

        • qCardinal integer

          Number of distinct field values.

          format = int32

        • qSortIndicator string

          Can be one of: "N""A""D"

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qMin number

          Lowest value in the range.

          format = double

        • qMax number

          Highest value in the range.

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qReverseSort boolean

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

        • 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 expression.

        • qAttrExprInfo array of objects

          List of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • 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 expression.
        • qAttrDimInfo array of objects

          List of attribute dimensions.

          Show qAttrDimInfo properties
          • qCardinal integer

            Cardinality of the attribute expression.

            format = int32

          • qSize object
            Show qSize properties
            • qcx integer

              Number of pixels on the x axis.

              format = int32

            • qcy integer

              Number of pixels on the y axis.

              format = int32

          • qFallbackTitle string

            The title for the attribute dimension.

          • qLocked boolean

            The Locked value of the dimension.

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qIsCalculated boolean

            True if this is a calculated dimension.

            default = false

        • qCalcCondMsg string

          The message displayed if calculation condition is not fulfilled.

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qTrendLines array of objects
          Experimental

          Calculated trendlines

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qCoeff array of numbers

            Coefficent c0..cN depending on the trendline type.

          • qR2 number

            R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

            format = double

          • qExpression string

            Trendline expression

          • qElemNo integer

            Inner Dim elem no

            format = int32

        • qMiniChart object
          Show qMiniChart properties
          • qYMin number

            format = double

          • qYMax number

            format = double

          • qXMin number

            format = double

          • qXMax number

            format = double

          • qAttrExprInfo array of objects

            List of attribute expressions.

            Show qAttrExprInfo properties
            • qMin number

              Minimum value.

              format = double

            • qMax number

              Maximum value.

              format = double

            • qFallbackTitle string
            • qMinText string

              String version of the minimum Value.

            • qMaxText string

              String version of the maximum Value.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • 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 expression.
          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
      • qAttrExprInfo array of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qAttrDimInfo array of objects

        List of attribute dimensions.

        Show qAttrDimInfo properties
        • qCardinal integer

          Cardinality of the attribute expression.

          format = int32

        • qSize object
          Show qSize properties
          • qcx integer

            Number of pixels on the x axis.

            format = int32

          • qcy integer

            Number of pixels on the y axis.

            format = int32

        • qFallbackTitle string

          The title for the attribute dimension.

        • qLocked boolean

          The Locked value of the dimension.

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

      • qCalcCondMsg string

        The message displayed if calculation condition is not fulfilled.

      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

      • qIsOneAndOnlyOne boolean

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

      • qCardinalities object
        Show qCardinalities properties
        • qCardinal integer

          Number of distinct field values.

          format = int32

        • qHypercubeCardinal integer

          Number of distinct hypercube values.

          format = int32

        • qAllValuesCardinal integer

          Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

          default = -1, format = int32, default = -1

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qEffectiveDimensionName string
        Experimental

        The expanded and stripped dimension name used internally in engine.
    • qEffectiveInterColumnSortOrder array of integers

      Defines the order of the dimenion levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2.

    • qHasOtherValues boolean

      True if other row exists.

    • qTitle string

      Title of the TreeData object, for example the title of a chart.

    • qLastExpandedPos object
      Show qLastExpandedPos properties
      • qx integer

        Position of the cell on the x-axis.

        format = int32

      • qy integer

        Position of the cell on the y-axis.

        format = int32

    • qCalcCondMsg string

      The message displayed if calculation condition is not fulfilled.

    • qTreeDataPages array of objects

      Set of data. Is empty if nothing has been defined in qInitialDataFetch in TreeDataDef.

      Show qTreeDataPages properties
      • qText string

        The text version of the value, if available.

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qElemNo integer

        Element number.

        format = int32

      • qGroupPos integer

        The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

        format = int32

      • qGroupSize integer

        Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

        format = int32

      • qRow integer

        Row index in the data matrix. The indexing starts from 0.

        format = int32

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qValues array of objects

        The measures for this node.

        Show qValues properties
        • qText string

          The text version of the value, if available.

        • qValue number

          Value of the cell. Is set to NaN , if the value is not a number.

          format = double

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

      • qNodes array of undefineds

        The children of this node in the fetched tree structure.

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qMaxPos array of numbers

        Total of the positive values in the current group of cells.

      • qMinNeg array of numbers

        Total of the negative values in the current group of cells.

      • qCanExpand boolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapse boolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qTreePath array of integers

        The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.
    • qMeasureInfo array of objects

      Information on the measures calculated on the whole tree.

      Show qMeasureInfo properties
      • qFallbackTitle string

        Corresponds to the label of the measure. If the label is not defined then the measure name is used.

      • qApprMaxGlyphCount integer

        Length of the longest value in the field.

        format = int32

      • qCardinal integer

        Number of distinct field values.

        format = int32

      • qSortIndicator string

        Can be one of: "N""A""D"

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qMin number

        Lowest value in the range.

        format = double

      • qMax number

        Highest value in the range.

        format = double

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qReverseSort boolean

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

      • 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 expression.

      • qAttrExprInfo array of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qAttrDimInfo array of objects

        List of attribute dimensions.

        Show qAttrDimInfo properties
        • qCardinal integer

          Cardinality of the attribute expression.

          format = int32

        • qSize object
          Show qSize properties
          • qcx integer

            Number of pixels on the x axis.

            format = int32

          • qcy integer

            Number of pixels on the y axis.

            format = int32

        • qFallbackTitle string

          The title for the attribute dimension.

        • qLocked boolean

          The Locked value of the dimension.

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

      • qCalcCondMsg string

        The message displayed if calculation condition is not fulfilled.

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qTrendLines array of objects
        Experimental

        Calculated trendlines

        Show qTrendLines properties
        • qType string

          Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qCoeff array of numbers

          Coefficent c0..cN depending on the trendline type.

        • qR2 number

          R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

          format = double

        • qExpression string

          Trendline expression

        • qElemNo integer

          Inner Dim elem no

          format = int32

      • qMiniChart object
        Show qMiniChart properties
        • qYMin number

          format = double

        • qYMax number

          format = double

        • qXMin number

          format = double

        • qXMax number

          format = double

        • qAttrExprInfo array of objects

          List of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • 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 expression.
        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
  • qUndoInfo object

    Displays information about the number of possible undos and redos. Is the layout for UndoInfoDef.

    Show qUndoInfo properties
    • qUndoCount integer

      Number of possible undos.

      format = int32

    • qRedoCount integer

      Number of possible redos.

      format = int32

  • qVariableList object

    Lists the variables in an app. Is the layout for VariableListDef.

    Show qVariableList properties
    • qItems array of objects

      List of the variables.

      Show qItems properties
      • qName string

        Name of the variable.

      • qDescription string

        Description of the variable.

      • qDefinition string

        Definition of the variable. It can be a value or an expression.

      • qIsConfig boolean

        If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false.

        default = false

      • qIsReserved boolean

        If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples:

        • ScriptError is a reserved variable, set by the engine.
        • DayNames is a reserved variable, set by the user.

        default = false

      • qMeta object

        Layout for NxMetaDef.

        Show qMeta properties
        • qName string

          Name. This property is optional.
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qData object

        Contains dynamic JSON data specified by the client.

      • qIsScriptCreated boolean

        If set to true, it means that the variable was defined via script.

schemas GenericObjectProperties object

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qExtendsId string

    Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

  • qMetaDef object

    Used to collect metadata.

    Properties

    Semantic type with an empty structure.

  • qStateName string

    Name of the alternate state. Default is current selections $ .

  • qAppObjectListDef object

    Defines the list of objects in an app.

    An app object is a generic object created at app level.
    Show qAppObjectListDef properties
    • qType string

      Type of the app list.

    • qData object

      Contains dynamic JSON data specified by the client.
  • qBookmarkListDef object

    Defines the list of bookmarks.

    Show qBookmarkListDef properties
    • qType string

      Type of the list.

    • qData object

      Contains dynamic JSON data specified by the client.

    • qIncludePatches boolean

      Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
  • qChildListDef object

    Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

    Show qChildListDef properties
    • qData object

      Contains dynamic JSON data specified by the client.
  • qDimensionListDef object

    Defines the lists of dimensions.

    Show qDimensionListDef properties
    • qType string

      Type of the list.

    • qData object

      Contains dynamic JSON data specified by the client.
  • qEmbeddedSnapshotDef object

    Defines the embedded snapshot in a generic object.

    Properties

    "EmbeddedSnapshotDef": {}

  • qExtensionListDef object

    Obsolete, use qrs API's to fetch extensions.

  • qFieldListDef object

    Defines the fields to show.

    Show qFieldListDef properties
    • qShowSystem boolean

      Shows the system tables if set to true. Default is false.

      default = false

    • qShowHidden boolean

      Shows the hidden fields if set to true. Default is false.

      default = false

    • qShowSemantic boolean

      Show the semantic fields if set to true. Default is false.

      default = false

    • qShowSrcTables boolean

      Shows the tables and fields present in the data model viewer if set to true. Default is false.

      default = false

    • qShowDefinitionOnly boolean

      Shows the fields defined on the fly if set to true. Default is false.

      default = false

    • qShowDerivedFields boolean

      Shows the fields and derived fields if set to true. Default is false.

      default = false

    • qShowImplicit boolean

      Shows the Direct Discovery measure fields if set to true. Default is false.

      default = false

  • qHyperCubeDef object

    Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

    Show qHyperCubeDef properties
    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qDimensions array of objects

      Array of dimensions.

      Show qDimensions properties
      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSort boolean

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

        • qActiveField integer

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

          Alias of the dimension.
      • qNullSuppression boolean

        If set to true, no null values are returned.

      • qIncludeElemValue boolean
      • qOtherTotalSpec object
        Show qOtherTotalSpec properties
        • qOtherMode string

          Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

        • qOtherCounted object
          Show qOtherCounted properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimit object
          Show qOtherLimit properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimitMode string

          Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

        • qSuppressOther boolean

          If set to true, the group Others is not displayed as a dimension value. The default value is false.

          default = false

        • qForceBadValueKeeping boolean

          This parameter is used when qOtherMode is set to:

          • OTHER_ABS_LIMITED
          • OTHER_REL_LIMITED
          • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

          and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

          default = true

        • qApplyEvenWhenPossiblyWrongResult boolean

          Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

          default = true

        • qGlobalOtherGrouping boolean

          This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

          default = false

        • qOtherCollapseInnerDimensions boolean

          If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

          default = false

        • qOtherSortMode string

          Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

        • qTotalMode string

          Can be one of: "TOTAL_OFF""TOTAL_EXPR"

        • qReferencedExpression object
          Show qReferencedExpression properties
          • qv string

            Expression evaluated to string.
      • qShowTotal boolean
      • qShowAll boolean

        If set to true, all dimension values are shown.

      • qOtherLabel object
        Show qOtherLabel properties
        • qv string

          Expression evaluated to string.
      • qTotalLabel object
        Show qTotalLabel properties
        • qv string

          Expression evaluated to string.
      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qAttributeExpressions array of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpression string

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryId string

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttribute boolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabel string

          Label of the attribute expression.

        • qLabelExpression string

          Optional expression used for dynamic label.
      • qAttributeDimensions array of objects

        List of attribute dimensions.

        Show qAttributeDimensions properties
        • qDef string

          Expression or field name.

        • qLibraryId string

          LibraryId for dimension.

        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttribute boolean

          If set to true, this attribute will not affect the number of rows in the cube.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
    • qMeasures array of objects

      Array of measures.

      Show qMeasures properties
      • qLibraryId string

        Refers to a measure stored in the library.

      • qDef object
        Show qDef properties
        • qLabel string

          Name of the measure. An empty string is returned as a default value. This parameter is optional.

        • qDescription string

          Description of the measure. An empty string is returned as a default value. This parameter is optional.

        • qTags array of strings

          Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

        • qGrouping string

          Can be one of: "N""H""C"

        • qDef string

          Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRelative boolean

          If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

        • qBrutalSum boolean

          If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

        • qAggrFunc string

          Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

        • qAccumulate integer
          • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

          format = int32

        • qReverseSort boolean

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

        • qActiveExpression integer

          Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

          format = int32

        • qExpressions array of strings

          Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

        • qLabelExpression string

          Label expression. This parameter is optional.
      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qAttributeExpressions array of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpression string

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryId string

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttribute boolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabel string

          Label of the attribute expression.

        • qLabelExpression string

          Optional expression used for dynamic label.
      • qAttributeDimensions array of objects

        List of attribute dimensions.

        Show qAttributeDimensions properties
        • qDef string

          Expression or field name.

        • qLibraryId string

          LibraryId for dimension.

        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttribute boolean

          If set to true, this attribute will not affect the number of rows in the cube.
      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTrendLines array of objects
        Experimental

        Specifies trendlines for this measure.

        Show qTrendLines properties
        • qType string

          Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

        • qXColIx integer

          The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

          default = -1, format = int32, default = -1

        • qCalcR2 boolean

          Set to true to calulatate the R2 score

          default = false

        • qContinuousXAxis string

          Can be one of: "Never""Possible""Time"

        • qMultiDimMode string

          Can be one of: "Multi""Sum"

      • qMiniChartDef object
        Show qMiniChartDef properties
        • qDef string

          Expression or field name.

        • qLibraryId string

          LibraryId for dimension.

        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qMaxNumberPoints integer

          default = -1, format = int32, default = -1

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qNullSuppression boolean

          If set to true, no null values are returned.
    • qInterColumnSortOrder array of integers

      Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

    • qSuppressZero boolean

      Removes zero values.

      default = false

    • qSuppressMissing boolean

      Removes missing values.

      default = false

    • qInitialDataFetch array of objects

      Initial data set.

      Show qInitialDataFetch properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qReductionMode string

      Can be one of: "N""D1""S""C""ST"

    • qMode string

      Can be one of: "S""P""K""T""D"

    • qPseudoDimPos integer

      default = -1, format = int32, default = -1

    • qNoOfLeftDims integer

      Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

      • Four dimensions in the following order: Country, City, Product and Category.
      • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
      • Three left dimensions ( qNoOfLeftDims is set to 3).

      implies that:

      • The index 0 corresponds to the left dimension Country.
      • The index 1 corresponds to the pseudo dimension.
      • The index 2 corresponds to the left dimension City.
      • Product and Category are top dimensions.

      Another example:

      • Four dimensions in the following order: Country, City, Product and Category.
      • Three left dimensions ( qNoOfLeftDims is set to 3).
      • One pseudo dimension.
      • The property qInterColumnSortOrder is left empty.

      Implies that:

      • The index 0 corresponds to the left dimension Country.
      • The index 1 corresponds to the left dimension City.
      • The index 2 corresponds to the left dimension Product.
      • Category is a top dimension.
      • The pseudo dimension is a top dimension.

      default = -1, format = int32, default = -1

    • qAlwaysFullyExpanded boolean

      If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

      default = false

    • qMaxStackedCells integer

      Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

      default = 5000, format = int32, default = 5000

    • qPopulateMissing boolean

      If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

      default = false

    • qShowTotalsAbove boolean

      If set to true, the total (if any) is shown on the first row. The default value is false.

      default = false

    • qIndentMode boolean

      This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

      default = false

    • qCalcCond object
      Show qCalcCond properties
      • qv string

        Expression evaluated to dual.
    • qSortbyYValue integer

      To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

      default = 0, format = int8, default = 0

    • qTitle object
      Show qTitle properties
      • qv string

        Expression evaluated to string.
    • qCalcCondition object
      Show qCalcCondition properties
      • qCond object
        Show qCond properties
        • qv string

          Expression evaluated to dual.
      • qMsg object
        Show qMsg properties
        • qv string

          Expression evaluated to string.
    • qColumnOrder array of integers

      The order of the columns.

    • qExpansionState array of objects
      Experimental

      Expansion state per dimension for pivot mode ( qMode is P).

      Show qExpansionState properties
      • qExcludeList boolean
      • qPos object
        Show qPos properties
        • qDimName string
        • qElemNo array of integers
        • qElemValues array of strings
    • qDynamicScript array of strings
      Experimental

      Hypercube Modifier Dynamic script string

    • qContextSetExpression string

      Set expression valid for the whole cube, limiting computations to the specified set.

    • qSuppressMeasureTotals boolean

      When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
  • qLayoutExclude object

    Contains JSON to be excluded from validation.

  • qListObjectDef object

    Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

    Show qListObjectDef properties
    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qLibraryId string

      Refers to a dimension stored in the library.

    • qDef object
      Show qDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

      • qFieldLabels array of strings

        Array of field labels. This parameter is optional.

      • qSortCriterias array of objects

        Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

        Show qSortCriterias properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qNumberPresentations array of objects

        Defines the format of the value. This parameter is optional.

        Show qNumberPresentations properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qReverseSort boolean

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

      • qActiveField integer

        Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

        format = int32

      • qLabelExpression string

        Label expression. This parameter is optional.

      • qAlias string

        Alias of the dimension.
    • qAutoSortByState object
      Show qAutoSortByState properties
      • qDisplayNumberOfRows integer

        This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

        format = int32

    • qFrequencyMode string

      Can be one of: "N""V""P""R"

    • qShowAlternatives boolean

      If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

    • qInitialDataFetch array of objects

      Fetches an initial data set.

      Show qInitialDataFetch properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qExpressions array of objects

      Lists the expressions in the list object. This parameter is optional.

      Show qExpressions properties
      • qExpr string

        Value of the expression.

      • qLibraryId string

        Refers to an expression stored in the library.
    • qDirectQuerySimplifiedView boolean
      Experimental

      If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
  • qMeasureListDef object

    Defines the list of measures.

    Show qMeasureListDef properties
    • qType string

      Type of the list.

    • qData object

      Contains dynamic JSON data specified by the client.
  • qMediaListDef object

    Defines the list of media files.

    This struct is deprecated.

    Properties

    "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

  • qNxLibraryDimensionDef object
    Show qNxLibraryDimensionDef properties
    • qGrouping string

      Can be one of: "N""H""C"

    • qFieldDefs array of strings

      Array of dimension names.

    • qFieldLabels array of strings

      Array of dimension labels.

    • qLabelExpression string
    • qAlias string

      Alias of the dimension.

    • qScriptGenerated boolean Deprecated

      default = false

    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

  • qNxLibraryMeasureDef object
    Show qNxLibraryMeasureDef properties
    • qLabel string

      Label of the measure.

    • qDef string

      Definition of the measure.

    • qGrouping string

      Can be one of: "N""H""C"

    • qExpressions array of strings

      Array of expressions.

    • qActiveExpression integer

      Index to the active expression in a measure.

      format = int32

    • qLabelExpression string

      Optional expression used for dynamic label.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qScriptGenerated boolean Deprecated

      default = false

    • qOrigin string

      Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

  • qSelectionObjectDef object

    To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

    Properties

    "qSelectionObjectDef": {}

    Show qSelectionObjectDef properties
    • qStateName string

      Name of the alternate state. Default is current selections $ .
  • qStaticContentUrlDef object
    In addition, this structure can contain dynamic properties.
    Show qStaticContentUrlDef properties
    • qUrl string

      Relative path of the thumbnail.
  • qStringExpression object

    Properties

    Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

    • < expression > is a string
    The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
    A string expression is not evaluated, if the expression is surrounded by simple quotes.
    The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
    Show qStringExpression properties
    • qExpr string
  • qTreeDataDef object

    Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

    Show qTreeDataDef properties
    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qDimensions array of objects

      Array of dimensions.

      Show qDimensions properties
      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSort boolean

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

        • qActiveField integer

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

          Alias of the dimension.
      • qValueExprs array of objects

        List of measures.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

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

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              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:

              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.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qNullSuppression boolean

        If set to true, no null values are returned.

      • qOtherTotalSpec object
        Show qOtherTotalSpec properties
        • qOtherMode string

          Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

        • qOtherCounted object
          Show qOtherCounted properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimit object
          Show qOtherLimit properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimitMode string

          Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

        • qSuppressOther boolean

          If set to true, the group Others is not displayed as a dimension value. The default value is false.

          default = false

        • qForceBadValueKeeping boolean

          This parameter is used when qOtherMode is set to:

          • OTHER_ABS_LIMITED
          • OTHER_REL_LIMITED
          • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

          and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

          default = true

        • qApplyEvenWhenPossiblyWrongResult boolean

          Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

          default = true

        • qGlobalOtherGrouping boolean

          This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

          default = false

        • qOtherCollapseInnerDimensions boolean

          If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

          default = false

        • qOtherSortMode string

          Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

        • qTotalMode string

          Can be one of: "TOTAL_OFF""TOTAL_EXPR"

        • qReferencedExpression object
          Show qReferencedExpression properties
          • qv string

            Expression evaluated to string.
      • qShowAll boolean

        If set to true, all dimension values are shown.

      • qOtherLabel object
        Show qOtherLabel properties
        • qv string

          Expression evaluated to string.
      • qTotalLabel object
        Show qTotalLabel properties
        • qv string

          Expression evaluated to string.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qAttributeExpressions array of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpression string

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryId string

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttribute boolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabel string

          Label of the attribute expression.

        • qLabelExpression string

          Optional expression used for dynamic label.
      • qAttributeDimensions array of objects

        List of attribute dimensions.

        Show qAttributeDimensions properties
        • qDef string

          Expression or field name.

        • qLibraryId string

          LibraryId for dimension.

        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttribute boolean

          If set to true, this attribute will not affect the number of rows in the cube.
    • qInterColumnSortOrder array of integers

      Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

    • qSuppressZero boolean

      Removes zero values.

      default = false

    • qSuppressMissing boolean

      Removes missing values.

      default = false

    • qOpenFullyExpanded boolean

      If this property is set to true, the cells are opened expanded. The default value is false.

      default = false

    • qPopulateMissing boolean

      If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

      default = false

    • qCalcCondition object
      Show qCalcCondition properties
      • qCond object
        Show qCond properties
        • qv string

          Expression evaluated to dual.
      • qMsg object
        Show qMsg properties
        • qv string

          Expression evaluated to string.
    • qTitle object
      Show qTitle properties
      • qv string

        Expression evaluated to string.
    • qInitialDataFetch array of objects

      Initial data set. This property is optional.

      Show qInitialDataFetch properties
      • qMaxNbrOfNodes integer

        Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

        format = int32

      • qTreeNodes array of objects

        Defines areas of the tree to be fetched. Areas must be defined left to right.

        Show qTreeNodes properties
        • qArea object
          Show qArea properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qAllValues boolean

          When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
      • qTreeLevels object
        Show qTreeLevels properties
        • qLeft integer

          The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

          format = int32

        • qDepth integer

          Number of dimensions to include in the tree.

          default = -1, format = int32, default = -1

    • qExpansionState array of objects
      Experimental

      Expansion state per dimension.

      Show qExpansionState properties
      • qExcludeList boolean
      • qPos object
        Show qPos properties
        • qDimName string
        • qElemNo array of integers
        • qElemValues array of strings
    • qValueExprs array of objects

      List of measures to calculate on the whole tree.

      Show qValueExprs properties
      • qLibraryId string

        Refers to a measure stored in the library.

      • qDef object
        Show qDef properties
        • qLabel string

          Name of the measure. An empty string is returned as a default value. This parameter is optional.

        • qDescription string

          Description of the measure. An empty string is returned as a default value. This parameter is optional.

        • qTags array of strings

          Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

        • qGrouping string

          Can be one of: "N""H""C"

        • qDef string

          Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRelative boolean

          If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

        • qBrutalSum boolean

          If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

        • qAggrFunc string

          Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

        • qAccumulate integer
          • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

          format = int32

        • qReverseSort boolean

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

        • qActiveExpression integer

          Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

          format = int32

        • qExpressions array of strings

          Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

        • qLabelExpression string

          Label expression. This parameter is optional.
      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qAttributeExpressions array of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpression string

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryId string

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttribute boolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabel string

          Label of the attribute expression.

        • qLabelExpression string

          Optional expression used for dynamic label.
      • qAttributeDimensions array of objects

        List of attribute dimensions.

        Show qAttributeDimensions properties
        • qDef string

          Expression or field name.

        • qLibraryId string

          LibraryId for dimension.

        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttribute boolean

          If set to true, this attribute will not affect the number of rows in the cube.
      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTrendLines array of objects
        Experimental

        Specifies trendlines for this measure.

        Show qTrendLines properties
        • qType string

          Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

        • qXColIx integer

          The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

          default = -1, format = int32, default = -1

        • qCalcR2 boolean

          Set to true to calulatate the R2 score

          default = false

        • qContinuousXAxis string

          Can be one of: "Never""Possible""Time"

        • qMultiDimMode string

          Can be one of: "Multi""Sum"

      • qMiniChartDef object
        Show qMiniChartDef properties
        • qDef string

          Expression or field name.

        • qLibraryId string

          LibraryId for dimension.

        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qMaxNumberPoints integer

          default = -1, format = int32, default = -1

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qNullSuppression boolean

          If set to true, no null values are returned.
    • qContextSetExpression string

      Set expression valid for the whole cube, limiting computations to the specified set.
  • qUndoInfoDef object

    Defines if an object should contain information on the number of possible undo and redo.

    Properties

    "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

  • qValueExpression object

    Properties

    Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

    • < expression > is a string.
    The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
    The expression is evaluated as a numeric.
    Show qValueExpression properties
    • qExpr string
  • qVariableListDef object

    Defines the list of variables in an app.

    Show qVariableListDef properties
    • qType string

      Type of variables to include in the list.

    • qShowReserved boolean

      Shows the reserved variables if set to true.

    • qShowConfig boolean

      Shows the system variables if set to true.

    • qData object

      Contains dynamic JSON data specified by the client.

    • qShowSession boolean

      Shows the session variables if set to true.

schemas GenericVariableConstraints object

Properties

  • qType string

    Can be one of: "any""number""text"

  • qValuesText array of strings
  • qValuesNum array of numbers

schemas GenericVariableLayout object

Is the layout for GenericVariableProperties.

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qText string

    Some text.

  • qNum number

    A value.

    format = double

  • qIsScriptCreated boolean

    If set to true, it means that the variable was defined via script.

schemas GenericVariableProperties object

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMetaDef object

    Used to collect metadata.

    Properties

    Semantic type with an empty structure.

  • qName string

    Name of the variable. The name must be unique. This parameter is mandatory.

  • qComment string

    Comment related to the variable. This parameter is optional.

  • qNumberPresentation object

    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:

    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.

    Show qNumberPresentation properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qIncludeInBookmark boolean

    Set this property to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark. The value of a variable can affect the state of the selections. Script variables cannot be persisted in the bookmark. The default value is false.

    default = false

  • qDefinition string

    Definition of the variable.

  • qConstraints object
    Show qConstraints properties
    • qType string

      Can be one of: "any""number""text"

    • qValuesText array of strings
    • qValuesNum array of numbers

schemas GenericVariableType string

oneOf

  • any

    VARIABLE_TYPE_ANY

  • number

    VARIABLE_TYPE_NUMBER

  • text

    VARIABLE_TYPE_TEXT

schemas GraphMode string

oneOf

  • GRAPH_MODE_BAR

  • GRAPH_MODE_PIE

  • GRAPH_MODE_PIVOTTABLE

  • GRAPH_MODE_SCATTER

  • GRAPH_MODE_LINE

  • GRAPH_MODE_STRAIGHTTABLE

  • GRAPH_MODE_COMBO

  • GRAPH_MODE_RADAR

  • GRAPH_MODE_GAUGE

  • GRAPH_MODE_GRID

  • GRAPH_MODE_BLOCK

  • GRAPH_MODE_FUNNEL

  • GRAPH_MODE_MEKKO

  • GRAPH_MODE_LAST

schemas GroupBookmarkData object

Properties

  • qId string
  • qCyclePos integer

    format = int32

schemas GroupState object

Experimental

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qActiveFieldDef string

    String defining the active field.

schemas GroupStateInfo object

Properties

  • qGroupName string
  • qCurrentItemName string

schemas HyperCube object

Renders the properties of a hypercube. Is the layout for HyperCubeDef. For more information about the definition of a hypercube, see Generic object.

What is returned in HyperCube depends on the type of the hypercube (straight, pivot or stacked table, or tree) and on the method called (GetLayout, GetHyperCubeData, GetHyperCubePivotData, GetHyperCubeStackData, GetHyperCubeTreeData).

Properties

  • qStateName string

    Name of the alternate state. Default is current selections $ .

  • qSize object
    Show qSize properties
    • qcx integer

      Number of pixels on the x axis.

      format = int32

    • qcy integer

      Number of pixels on the y axis.

      format = int32

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.
  • qDimensionInfo array of objects

    Information on the dimension.

    Show qDimensionInfo properties
    • qFallbackTitle string

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

    • qApprMaxGlyphCount integer

      Length of the longest value in the field.

      format = int32

    • qCardinal integer Deprecated

      Number of distinct field values.

      format = int32

    • qLocked boolean

      Is set to true if the field is locked.

    • qSortIndicator string

      Can be one of: "N""A""D"

    • qGroupFallbackTitles array of strings

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

    • qGroupPos integer

      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.

      format = int32

    • qStateCounts object
      Show qStateCounts properties
      • qLocked integer

        Number of values in locked state.

        format = int32

      • qSelected integer

        Number of values in selected state.

        format = int32

      • qOption integer

        Number of values in optional state.

        format = int32

      • qDeselected integer

        Number of values in deselected state.

        format = int32

      • qAlternative integer

        Number of values in alternative state.

        format = int32

      • qExcluded integer

        Number of values in excluded state.

        format = int32

      • qSelectedExcluded integer

        Number of values in selected excluded state.

        format = int32

      • qLockedExcluded integer

        Number of values in locked excluded state.

        format = int32

    • qTags array of strings

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

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qDimensionType string

      Can be one of: "D""N""T"

    • qReverseSort boolean

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

    • qGrouping string

      Can be one of: "N""H""C"

    • qIsSemantic boolean

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

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • 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.

    • qGroupFieldDefs array of strings

      Array of field names.

    • qMin number

      Minimum value.

      format = double

    • qMax number

      Maximum value.

      format = double

    • qContinuousAxes boolean

      Is continuous axis used.

    • qIsCyclic boolean

      Is a cyclic dimension used.

    • qDerivedField boolean

      Is derived field is used as a dimension.

    • qAttrExprInfo array of objects

      Array of attribute expressions.

      Show qAttrExprInfo properties
      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qFallbackTitle string
      • qMinText string

        String version of the minimum Value.

      • qMaxText string

        String version of the maximum Value.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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 expression.
    • qAttrDimInfo array of objects

      Array of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinal integer

        Cardinality of the attribute expression.

        format = int32

      • qSize object
        Show qSize properties
        • qcx integer

          Number of pixels on the x axis.

          format = int32

        • qcy integer

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitle string

        The title for the attribute dimension.

      • qLocked boolean

        The Locked value of the dimension.

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsg string

      The message displayed if calculation condition is not fulfilled.

    • qIsCalculated boolean

      True if this is a calculated dimension.

      default = false

    • qIsOneAndOnlyOne boolean

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

    • qCardinalities object
      Show qCardinalities properties
      • qCardinal integer

        Number of distinct field values.

        format = int32

      • qHypercubeCardinal integer

        Number of distinct hypercube values.

        format = int32

      • qAllValuesCardinal integer

        Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

        default = -1, format = int32, default = -1

    • qLibraryId string

      Refers to a dimension stored in the library.

    • qEffectiveDimensionName string
      Experimental

      The expanded and stripped dimension name used internally in engine.
  • qMeasureInfo array of objects

    Information on the measure.

    Show qMeasureInfo properties
    • qFallbackTitle string

      Corresponds to the label of the measure. If the label is not defined then the measure name is used.

    • qApprMaxGlyphCount integer

      Length of the longest value in the field.

      format = int32

    • qCardinal integer

      Number of distinct field values.

      format = int32

    • qSortIndicator string

      Can be one of: "N""A""D"

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qMin number

      Lowest value in the range.

      format = double

    • qMax number

      Highest value in the range.

      format = double

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qReverseSort boolean

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

    • 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 expression.

    • qAttrExprInfo array of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qFallbackTitle string
      • qMinText string

        String version of the minimum Value.

      • qMaxText string

        String version of the maximum Value.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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 expression.
    • qAttrDimInfo array of objects

      List of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinal integer

        Cardinality of the attribute expression.

        format = int32

      • qSize object
        Show qSize properties
        • qcx integer

          Number of pixels on the x axis.

          format = int32

        • qcy integer

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitle string

        The title for the attribute dimension.

      • qLocked boolean

        The Locked value of the dimension.

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsg string

      The message displayed if calculation condition is not fulfilled.

    • qLibraryId string

      Refers to a dimension stored in the library.

    • qTrendLines array of objects
      Experimental

      Calculated trendlines

      Show qTrendLines properties
      • qType string

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qCoeff array of numbers

        Coefficent c0..cN depending on the trendline type.

      • qR2 number

        R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

        format = double

      • qExpression string

        Trendline expression

      • qElemNo integer

        Inner Dim elem no

        format = int32

    • qMiniChart object
      Show qMiniChart properties
      • qYMin number

        format = double

      • qYMax number

        format = double

      • qXMin number

        format = double

      • qXMax number

        format = double

      • qAttrExprInfo array of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
  • qEffectiveInterColumnSortOrder array of integers

    Sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted was the column 1, followed by the column 0 and the column 2.

  • qGrandTotalRow array of objects

    Aggregate for measures of all values in the field. The result value depends on the qAggrFunc defined in HyperCubeDef.

    Show qGrandTotalRow properties
    • qText string

      Some text. This parameter is optional.

    • qNum number

      A value. This parameter is optional.

      format = double

    • qElemNumber integer

      Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

      • -1: the cell is a Total cell. It shows a total.
      • -2: the cell is a Null cell.
      • -3: the cell belongs to the group Others .
      • -4: the cell is empty. Applies to pivot tables.

      format = int32

    • qState string

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qIsEmpty boolean

      Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

    • qIsTotalCell boolean

      Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

    • qIsOtherCell boolean

      Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

    • qFrequency string

      Frequency of the value. This parameter is optional.

    • qHighlightRanges object
      Show qHighlightRanges properties
      • qRanges array of objects

        Ranges of highlighted values.

        Show qRanges properties
        • qCharPos integer

          Position of the first search occurrence.

          format = int32

        • qCharCount integer

          Number of occurrences found.

          format = int32

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

    • qIsNull boolean

      Is set to true if the value is Null.

    • qMiniChart object
      Show qMiniChart properties
      • qMatrix array of arrays

        Array of data.

        Show qMatrix properties
        • qText string

          Some text.

        • qNum number

          A value. This parameter is optional.

          format = double

        • qElemNumber integer

          Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

          • -1: the cell is a Total cell. It shows a total.
          • -2: the cell is a Null cell.
          • -3: the cell belongs to the group Others .
          • -4: the cell is empty. Applies to pivot tables.

          format = int32

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

      • qMin number

        format = double

      • qMax number

        format = double

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
    • qInExtRow boolean
  • qDataPages array of objects

    Set of data. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

    Show qDataPages properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text. This parameter is optional.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmpty boolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCell boolean

        Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

      • qIsOtherCell boolean

        Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

      • qFrequency string

        Frequency of the value. This parameter is optional.

      • qHighlightRanges object
        Show qHighlightRanges properties
        • qRanges array of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPos integer

            Position of the first search occurrence.

            format = int32

          • qCharCount integer

            Number of occurrences found.

            format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qIsNull boolean

        Is set to true if the value is Null.

      • qMiniChart object
        Show qMiniChart properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

        • qMin number

          format = double

        • qMax number

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
      • qInExtRow boolean
    • qTails array of objects

      Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

      Show qTails properties
      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

        format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qIsReduced boolean

      Is set to true, if the data have been reduced. The default value is false.

      default = false

  • qPivotDataPages array of objects

    Set of data for pivot tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

    Show qPivotDataPages properties
    • qLeft array of objects

      Information about the left dimension values of a pivot table.

      Show qLeft properties
      • qText string

        Some text.

      • qElemNo integer

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpand boolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapse boolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

        format = int32

      • qSubNodes array of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qTop array of objects

      Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.

      Show qTop properties
      • qText string

        Some text.

      • qElemNo integer

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpand boolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapse boolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

        format = int32

      • qSubNodes array of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qData array of arrays

      Array of data.

      Show qData properties
      • qLabel string

        Label of the cell. This parameter is optional.

      • qText string

        Some text related to the cell.

      • qNum number

        Value of the cell.

        format = double

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

  • qStackedDataPages array of objects

    Set of data for stacked tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

    Show qStackedDataPages properties
    • qData array of objects

      Array of data.

      Show qData properties
      • qText string

        Some text.

      • qElemNo integer

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpand boolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapse boolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qMaxPos number

        Total of the positive values in the current group of cells.

        format = double

      • qMinNeg number

        Total of the negative values in the current group of cells.

        format = double

      • qUp integer

        Number of elements that are part of the previous tail.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail.

        format = int32

      • qRow integer

        Row index in the data matrix. The indexing starts from 0.

        format = int32

      • qSubNodes array of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

  • qMode string

    Can be one of: "S""P""K""T""D"

  • qNoOfLeftDims integer

    Number of left dimensions. Default value is -1. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

    • Four dimensions in the following order: Country, City, Product and Category
    • One pseudo dimension in position 1
    • Three left dimensions.

    implies that:

    • The index 0 corresponds to the left dimension Country.
    • The index 1 corresponds to the pseudo dimension.
    • The index 2 corresponds to the left dimension City.
    • Product and Category are top dimensions.

    Another example:

    • Four dimensions in the following order: Country, City, Product and Category.
    • One pseudo dimension in position -1.
    • Three left dimensions.

    implies that:

    • The index -1 corresponds to the pseudo dimension; the pseudo dimension is the most to the right.
    • The index 0 corresponds to the left dimension Country.
    • The index 1 corresponds to the left dimension City.
    • The index 2 corresponds to the left dimension Product.
    • Category is a top dimension.

    format = int32

  • qIndentMode boolean

    Is used for pivot tables only. If set to true, the formatting of the results is slightly different. This property is optional.

  • qLastExpandedPos object
    Show qLastExpandedPos properties
    • qx integer

      Position of the cell on the x-axis.

      format = int32

    • qy integer

      Position of the cell on the y-axis.

      format = int32

  • qHasOtherValues boolean

    True if other row exists.

  • qTitle string

    Title of the hypercube, for example the title of a chart.

  • qTreeNodesOnDim array of integers

    The total number of nodes on each dimension (only applicable when qMode = T ).

  • qCalcCondMsg string

    The message displayed if calculation condition is not fulfilled.

  • qColumnOrder array of integers

    The order of the columns.

schemas HyperCubeDef object

Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

Properties

  • qStateName string

    Name of the alternate state. Default is current selections $ .

  • qDimensions array of objects

    Array of dimensions.

    Show qDimensions properties
    • qLibraryId string

      Refers to a dimension stored in the library.

    • qDef object
      Show qDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

      • qFieldLabels array of strings

        Array of field labels. This parameter is optional.

      • qSortCriterias array of objects

        Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

        Show qSortCriterias properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qNumberPresentations array of objects

        Defines the format of the value. This parameter is optional.

        Show qNumberPresentations properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qReverseSort boolean

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

      • qActiveField integer

        Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

        format = int32

      • qLabelExpression string

        Label expression. This parameter is optional.

      • qAlias string

        Alias of the dimension.
    • qNullSuppression boolean

      If set to true, no null values are returned.

    • qIncludeElemValue boolean
    • qOtherTotalSpec object
      Show qOtherTotalSpec properties
      • qOtherMode string

        Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

      • qOtherCounted object
        Show qOtherCounted properties
        • qv string

          Expression evaluated to dual.
      • qOtherLimit object
        Show qOtherLimit properties
        • qv string

          Expression evaluated to dual.
      • qOtherLimitMode string

        Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

      • qSuppressOther boolean

        If set to true, the group Others is not displayed as a dimension value. The default value is false.

        default = false

      • qForceBadValueKeeping boolean

        This parameter is used when qOtherMode is set to:

        • OTHER_ABS_LIMITED
        • OTHER_REL_LIMITED
        • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

        and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

        default = true

      • qApplyEvenWhenPossiblyWrongResult boolean

        Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

        default = true

      • qGlobalOtherGrouping boolean

        This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

        default = false

      • qOtherCollapseInnerDimensions boolean

        If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

        default = false

      • qOtherSortMode string

        Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

      • qTotalMode string

        Can be one of: "TOTAL_OFF""TOTAL_EXPR"

      • qReferencedExpression object
        Show qReferencedExpression properties
        • qv string

          Expression evaluated to string.
    • qShowTotal boolean
    • qShowAll boolean

      If set to true, all dimension values are shown.

    • qOtherLabel object
      Show qOtherLabel properties
      • qv string

        Expression evaluated to string.
    • qTotalLabel object
      Show qTotalLabel properties
      • qv string

        Expression evaluated to string.
    • qCalcCond object
      Show qCalcCond properties
      • qv string

        Expression evaluated to dual.
    • qAttributeExpressions array of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpression string

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryId string

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttribute boolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabel string

        Label of the attribute expression.

      • qLabelExpression string

        Optional expression used for dynamic label.
    • qAttributeDimensions array of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDef string

        Expression or field name.

      • qLibraryId string

        LibraryId for dimension.

      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qAttribute boolean

        If set to true, this attribute will not affect the number of rows in the cube.
    • qCalcCondition object
      Show qCalcCondition properties
      • qCond object
        Show qCond properties
        • qv string

          Expression evaluated to dual.
      • qMsg object
        Show qMsg properties
        • qv string

          Expression evaluated to string.
  • qMeasures array of objects

    Array of measures.

    Show qMeasures properties
    • qLibraryId string

      Refers to a measure stored in the library.

    • qDef object
      Show qDef properties
      • qLabel string

        Name of the measure. An empty string is returned as a default value. This parameter is optional.

      • qDescription string

        Description of the measure. An empty string is returned as a default value. This parameter is optional.

      • qTags array of strings

        Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

      • qGrouping string

        Can be one of: "N""H""C"

      • qDef string

        Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRelative boolean

        If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

      • qBrutalSum boolean

        If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

      • qAggrFunc string

        Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

      • qAccumulate integer
        • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

        format = int32

      • qReverseSort boolean

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

      • qActiveExpression integer

        Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

        format = int32

      • qExpressions array of strings

        Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

      • qLabelExpression string

        Label expression. This parameter is optional.
    • qSortBy object
      Show qSortBy properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qAttributeExpressions array of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpression string

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryId string

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttribute boolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabel string

        Label of the attribute expression.

      • qLabelExpression string

        Optional expression used for dynamic label.
    • qAttributeDimensions array of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDef string

        Expression or field name.

      • qLibraryId string

        LibraryId for dimension.

      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qAttribute boolean

        If set to true, this attribute will not affect the number of rows in the cube.
    • qCalcCond object
      Show qCalcCond properties
      • qv string

        Expression evaluated to dual.
    • qCalcCondition object
      Show qCalcCondition properties
      • qCond object
        Show qCond properties
        • qv string

          Expression evaluated to dual.
      • qMsg object
        Show qMsg properties
        • qv string

          Expression evaluated to string.
    • qTrendLines array of objects
      Experimental

      Specifies trendlines for this measure.

      Show qTrendLines properties
      • qType string

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qXColIx integer

        The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

        default = -1, format = int32, default = -1

      • qCalcR2 boolean

        Set to true to calulatate the R2 score

        default = false

      • qContinuousXAxis string

        Can be one of: "Never""Possible""Time"

      • qMultiDimMode string

        Can be one of: "Multi""Sum"

    • qMiniChartDef object
      Show qMiniChartDef properties
      • qDef string

        Expression or field name.

      • qLibraryId string

        LibraryId for dimension.

      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qOtherTotalSpec object
        Show qOtherTotalSpec properties
        • qOtherMode string

          Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

        • qOtherCounted object
          Show qOtherCounted properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimit object
          Show qOtherLimit properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimitMode string

          Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

        • qSuppressOther boolean

          If set to true, the group Others is not displayed as a dimension value. The default value is false.

          default = false

        • qForceBadValueKeeping boolean

          This parameter is used when qOtherMode is set to:

          • OTHER_ABS_LIMITED
          • OTHER_REL_LIMITED
          • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

          and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

          default = true

        • qApplyEvenWhenPossiblyWrongResult boolean

          Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

          default = true

        • qGlobalOtherGrouping boolean

          This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

          default = false

        • qOtherCollapseInnerDimensions boolean

          If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

          default = false

        • qOtherSortMode string

          Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

        • qTotalMode string

          Can be one of: "TOTAL_OFF""TOTAL_EXPR"

        • qReferencedExpression object
          Show qReferencedExpression properties
          • qv string

            Expression evaluated to string.
      • qMaxNumberPoints integer

        default = -1, format = int32, default = -1

      • qAttributeExpressions array of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpression string

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryId string

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttribute boolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabel string

          Label of the attribute expression.

        • qLabelExpression string

          Optional expression used for dynamic label.
      • qNullSuppression boolean

        If set to true, no null values are returned.
  • qInterColumnSortOrder array of integers

    Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

  • qSuppressZero boolean

    Removes zero values.

    default = false

  • qSuppressMissing boolean

    Removes missing values.

    default = false

  • qInitialDataFetch array of objects

    Initial data set.

    Show qInitialDataFetch properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qReductionMode string

    Can be one of: "N""D1""S""C""ST"

  • qMode string

    Can be one of: "S""P""K""T""D"

  • qPseudoDimPos integer

    default = -1, format = int32, default = -1

  • qNoOfLeftDims integer

    Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

    • Four dimensions in the following order: Country, City, Product and Category.
    • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
    • Three left dimensions ( qNoOfLeftDims is set to 3).

    implies that:

    • The index 0 corresponds to the left dimension Country.
    • The index 1 corresponds to the pseudo dimension.
    • The index 2 corresponds to the left dimension City.
    • Product and Category are top dimensions.

    Another example:

    • Four dimensions in the following order: Country, City, Product and Category.
    • Three left dimensions ( qNoOfLeftDims is set to 3).
    • One pseudo dimension.
    • The property qInterColumnSortOrder is left empty.

    Implies that:

    • The index 0 corresponds to the left dimension Country.
    • The index 1 corresponds to the left dimension City.
    • The index 2 corresponds to the left dimension Product.
    • Category is a top dimension.
    • The pseudo dimension is a top dimension.

    default = -1, format = int32, default = -1

  • qAlwaysFullyExpanded boolean

    If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

    default = false

  • qMaxStackedCells integer

    Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

    default = 5000, format = int32, default = 5000

  • qPopulateMissing boolean

    If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

    default = false

  • qShowTotalsAbove boolean

    If set to true, the total (if any) is shown on the first row. The default value is false.

    default = false

  • qIndentMode boolean

    This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

    default = false

  • qCalcCond object
    Show qCalcCond properties
    • qv string

      Expression evaluated to dual.
  • qSortbyYValue integer

    To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

    default = 0, format = int8, default = 0

  • qTitle object
    Show qTitle properties
    • qv string

      Expression evaluated to string.
  • qCalcCondition object
    Show qCalcCondition properties
    • qCond object
      Show qCond properties
      • qv string

        Expression evaluated to dual.
    • qMsg object
      Show qMsg properties
      • qv string

        Expression evaluated to string.
  • qColumnOrder array of integers

    The order of the columns.

  • qExpansionState array of objects
    Experimental

    Expansion state per dimension for pivot mode ( qMode is P).

    Show qExpansionState properties
    • qExcludeList boolean
    • qPos object
      Show qPos properties
      • qDimName string
      • qElemNo array of integers
      • qElemValues array of strings
  • qDynamicScript array of strings
    Experimental

    Hypercube Modifier Dynamic script string

  • qContextSetExpression string

    Set expression valid for the whole cube, limiting computations to the specified set.

  • qSuppressMeasureTotals boolean

    When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.

schemas InputFieldItem object

Properties

  • qFieldName string
  • qValues array of objects
    Show qValues properties
    • qText string

      Text related to the field value. This parameter is optional.

    • qIsNumeric boolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumber number

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

  • qPackedHashKeys array of integers

schemas InterFieldSortData object

Properties

  • qName string
  • qReversed boolean

schemas InteractDef object

Properties

  • qType string

    Can be one of: "IT_MSGBOX""IT_SCRIPTLINE""IT_BREAK""IT_INPUT""IT_END""IT_PASSWD""IT_USERNAME"

  • qTitle string

    Title used in the message box dialog. This property is relevant if qType is IT_MSGBOX.

  • qMsg string

    Message used in the message box dialog. This property is relevant if qType is IT_MSGBOX.

  • qButtons integer

    Buttons displayed in the message box dialog. This property is relevant if qType is IT_MSGBOX. One of:

    • 0 means that the qButtons property is not relevant.
    • 17 means that the message box contains the OK and Cancel buttons or the stop -sign icon.

    format = int32

  • qLine string

    Next script statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE.

  • qOldLineNr integer

    First line number of the previously executed statement. This property is used if the type of interaction is IT_SCRIPTLINE.

    format = int32

  • qNewLineNr integer

    First line number of the next statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE.

    format = int32

  • qPath string

    Path specified by the Include script variable. This property is used if the type of interaction is IT_SCRIPTLINE. Example of an Include variable: $(Include=lib:\\MyDataFiles\abc.txt);

  • qHidden boolean

    This property is set to true if the returned statement is an hidden script statement.

  • qResult integer

    Not relevant for describing the requested user interaction.

    format = int32

  • qInput string

    Is not used in Qlik Sense.

schemas InteractType string

oneOf

  • IT_MSGBOX

  • IT_SCRIPTLINE

  • IT_BREAK

  • IT_INPUT

  • IT_END

  • IT_PASSWD

  • IT_USERNAME

schemas JsonObject object

Contains dynamic JSON data specified by the client.

schemas KeyType string

oneOf

  • NOT_KEY

  • ANY_KEY

  • PRIMARY_KEY

  • PERFECT_KEY

schemas LayoutBookmarkData object

Properties

  • qId string
  • qActive boolean
  • qShowMode integer

    format = byte

  • qScrollPos object
    Show qScrollPos properties
    • qUsePosition boolean
    • qPos object
      Show qPos properties
      • qx integer

        x-coordinate in pixels. The origin is the top left of the screen.

        format = int32

      • qy integer

        y-coordinate in pixels. The origin is the top left of the screen.

        format = int32

schemas LayoutExclude object

Contains JSON to be excluded from validation.

schemas LayoutFieldInfo object

Metadata about the selection in a field.

Properties

  • qFieldName string

    The name of the field.

  • qValuesCount integer

    Number of selected values in the field.

    format = int32

  • qExcludedValuesCount integer

    Number of excluded values in the field.

    format = int32

schemas LineageInfo object

Properties

  • qDiscriminator string

    A string indicating the origin of the data:

    • [filename]: the data comes from a local file.
    • INLINE: the data is entered inline in the load script.
    • RESIDENT: the data comes from a resident table. The table name is listed.
    • AUTOGENERATE: the data is generated from the load script (no external table of data source).
    • Provider: the data comes from a data connection. The connector source name is listed.
    • [webfile]: the data comes from a web-based file.
    • STORE: path to QVD or TXT file where data is stored.
    • EXTENSION: the data comes from a Server Side Extension (SSE).
  • qStatement string

    The LOAD and SELECT script statements from the data load script.

schemas ListObject object

Renders the properties of a list object. Is the layout for ListObjectDef. For more information about the definition of a list object, see Generic object.

ListObject is used by the _GetLayout Method_ to display the properties of a list object.

Properties

  • qStateName string

    Name of the alternate state. Default is current selections $ .

  • qSize object
    Show qSize properties
    • qcx integer

      Number of pixels on the x axis.

      format = int32

    • qcy integer

      Number of pixels on the y axis.

      format = int32

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.
  • qDimensionInfo object
    Show qDimensionInfo properties
    • qFallbackTitle string

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

    • qApprMaxGlyphCount integer

      Length of the longest value in the field.

      format = int32

    • qCardinal integer Deprecated

      Number of distinct field values.

      format = int32

    • qLocked boolean

      Is set to true if the field is locked.

    • qSortIndicator string

      Can be one of: "N""A""D"

    • qGroupFallbackTitles array of strings

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

    • qGroupPos integer

      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.

      format = int32

    • qStateCounts object
      Show qStateCounts properties
      • qLocked integer

        Number of values in locked state.

        format = int32

      • qSelected integer

        Number of values in selected state.

        format = int32

      • qOption integer

        Number of values in optional state.

        format = int32

      • qDeselected integer

        Number of values in deselected state.

        format = int32

      • qAlternative integer

        Number of values in alternative state.

        format = int32

      • qExcluded integer

        Number of values in excluded state.

        format = int32

      • qSelectedExcluded integer

        Number of values in selected excluded state.

        format = int32

      • qLockedExcluded integer

        Number of values in locked excluded state.

        format = int32

    • qTags array of strings

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

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qDimensionType string

      Can be one of: "D""N""T"

    • qReverseSort boolean

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

    • qGrouping string

      Can be one of: "N""H""C"

    • qIsSemantic boolean

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

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • 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.

    • qGroupFieldDefs array of strings

      Array of field names.

    • qMin number

      Minimum value.

      format = double

    • qMax number

      Maximum value.

      format = double

    • qContinuousAxes boolean

      Is continuous axis used.

    • qIsCyclic boolean

      Is a cyclic dimension used.

    • qDerivedField boolean

      Is derived field is used as a dimension.

    • qAttrExprInfo array of objects

      Array of attribute expressions.

      Show qAttrExprInfo properties
      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qFallbackTitle string
      • qMinText string

        String version of the minimum Value.

      • qMaxText string

        String version of the maximum Value.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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 expression.
    • qAttrDimInfo array of objects

      Array of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinal integer

        Cardinality of the attribute expression.

        format = int32

      • qSize object
        Show qSize properties
        • qcx integer

          Number of pixels on the x axis.

          format = int32

        • qcy integer

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitle string

        The title for the attribute dimension.

      • qLocked boolean

        The Locked value of the dimension.

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsg string

      The message displayed if calculation condition is not fulfilled.

    • qIsCalculated boolean

      True if this is a calculated dimension.

      default = false

    • qIsOneAndOnlyOne boolean

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

    • qCardinalities object
      Show qCardinalities properties
      • qCardinal integer

        Number of distinct field values.

        format = int32

      • qHypercubeCardinal integer

        Number of distinct hypercube values.

        format = int32

      • qAllValuesCardinal integer

        Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

        default = -1, format = int32, default = -1

    • qLibraryId string

      Refers to a dimension stored in the library.

    • qEffectiveDimensionName string
      Experimental

      The expanded and stripped dimension name used internally in engine.
  • qExpressions array of objects

    Lists the expressions in the list object.

    Show qExpressions properties
    • qExpr string

      Value of the expression.

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code.

        format = int32

  • qDataPages array of objects

    Set of data. Is empty if nothing has been defined in qInitialDataFetch in ListObjectDef.

    Show qDataPages properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text. This parameter is optional.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmpty boolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCell boolean

        Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

      • qIsOtherCell boolean

        Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

      • qFrequency string

        Frequency of the value. This parameter is optional.

      • qHighlightRanges object
        Show qHighlightRanges properties
        • qRanges array of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPos integer

            Position of the first search occurrence.

            format = int32

          • qCharCount integer

            Number of occurrences found.

            format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qIsNull boolean

        Is set to true if the value is Null.

      • qMiniChart object
        Show qMiniChart properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

        • qMin number

          format = double

        • qMax number

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
      • qInExtRow boolean
    • qTails array of objects

      Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

      Show qTails properties
      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

        format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qIsReduced boolean

      Is set to true, if the data have been reduced. The default value is false.

      default = false

schemas ListObjectDef object

Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

Properties

  • qStateName string

    Name of the alternate state. Default is current selections $ .

  • qLibraryId string

    Refers to a dimension stored in the library.

  • qDef object
    Show qDef properties
    • qGrouping string

      Can be one of: "N""H""C"

    • qFieldDefs array of strings

      Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

    • qFieldLabels array of strings

      Array of field labels. This parameter is optional.

    • qSortCriterias array of objects

      Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

      Show qSortCriterias properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qNumberPresentations array of objects

      Defines the format of the value. This parameter is optional.

      Show qNumberPresentations properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qReverseSort boolean

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

    • qActiveField integer

      Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

      format = int32

    • qLabelExpression string

      Label expression. This parameter is optional.

    • qAlias string

      Alias of the dimension.
  • qAutoSortByState object
    Show qAutoSortByState properties
    • qDisplayNumberOfRows integer

      This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

      format = int32

  • qFrequencyMode string

    Can be one of: "N""V""P""R"

  • qShowAlternatives boolean

    If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

  • qInitialDataFetch array of objects

    Fetches an initial data set.

    Show qInitialDataFetch properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qExpressions array of objects

    Lists the expressions in the list object. This parameter is optional.

    Show qExpressions properties
    • qExpr string

      Value of the expression.

    • qLibraryId string

      Refers to an expression stored in the library.
  • qDirectQuerySimplifiedView boolean
    Experimental

    If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.

schemas LocaleInfo object

Properties

  • qDecimalSep string

    Decimal separator.

  • qThousandSep string

    Thousand separator.

  • qListSep string

    List separator.

  • qMoneyDecimalSep string

    Money decimal separator.

  • qMoneyThousandSep string

    Money thousand separator.

  • qCurrentYear integer

    Current year.

    format = int32

  • qMoneyFmt string

    Money format. Example: #.##0,00 kr;-#.##0,00 kr

  • qTimeFmt string

    Time format. Example: hh:mm:ss

  • qDateFmt string

    Date format. Example: YYYY-MM-DD

  • qTimestampFmt string

    Time stamp format. Example: YYYY-MM-DD hh:mm:ss[.fff]

  • qCalendarStrings object
    Show qCalendarStrings properties
    • qDayNames array of strings

      List of short day names.

    • qMonthNames array of strings

      List of short month names.

    • qLongDayNames array of strings

      List of long day names.

    • qLongMonthNames array of strings

      List of long month names.
  • qFirstWeekDay integer

    First day of the week, starting from 0. According to ISO 8601, Monday is the first day of the week.

    • 0 = Monday
    • 1 = Tuesday
    • ...
    • 6 = Sunday

    If this property has not been set in a script, the returned value comes from the Windows operating system.

    format = int32

  • qBrokenWeeks boolean

    Is set to true if broken weeks are allowed in a year. According to ISO 8601, no broken weeks should be allowed. This property is not shown if set to false. If qBrokenWeeks is set to true, qReferenceDay is irrelevant. If this property has not been set in a script, the returned value comes from the Windows operating system.

  • qReferenceDay integer

    Day in the year that is always in week 1. According to ISO 8601, January 4th should always be part of the first week of the year ( qReferenceDay =4). Recommended values are in the range 1 and 7. If this property has not been set in a script, the returned value comes from the Windows operating system. This property is not relevant if there are broken weeks in the year.

    format = int32

  • qFirstMonthOfYear integer

    First month of the year, starting from 1. According to ISO 8601, January is the first month of the year.

    • 1 = January
    • 2 = February
    • 12 = January

    If this property has not been set in a script, the returned value comes from the Windows operating system.

    format = int32

  • qCollation string

    Locale name (following language tagging convention RFC 4646): < language>-<REGION> Where:

    • language is a lowercase ISO  639 language code
    • REGION specifies an uppercase ISO 3166 country code.

    If this property has not been set in a script, the returned value comes from the Windows operating system.

  • qNumericalAbbreviation string

    Number format. Example: 3:k;6:M;9:G;12:T;15:P;18:E;21:Z;24:Y;-3:m;-6:μ;-9:n;-12:p;-15:f;-18:a;-21:z;-24:y

schemas LogOnType string

oneOf

  • LOG_ON_SERVICE_USER

  • LOG_ON_CURRENT_USER

schemas MeasureList object

Lists the measures. Is the layout for MeasureListDef.

Properties

  • qItems array of objects

    Information about the list of measures.

    Show qItems properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.
    • qData object

      Contains dynamic JSON data specified by the client.

schemas MeasureListDef object

Defines the list of measures.

Properties

  • qType string

    Type of the list.

  • qData object

    Contains dynamic JSON data specified by the client.

schemas MediaList object

Lists the media files. Is the layout for MediaListDef.

This struct is deprecated.

Properties

  • qItems array of objects

    Information about the list of media files. In Qlik Sense Desktop, the media files are retrieved from: %userprofile%\Documents\Qlik\Sense\Content\Default In Qlik Sense Enterprise, the media files are retrieved from: <installation_directory>\Qlik\Sense\Repository\Content\Default The default installation directory is ProgramData .

    Show qItems properties
    • qUrlDef string

      Relative path to the media file. The URL is static. Media files located:

      • in the /content/default/ folder are outside the qvf file.
      • in the /media/ folder are embedded in the qvf file.
    • qUrl string

      Relative path to the media file. Media files located:

      • in the /content/default/ folder are outside the qvf file.
      • in the /media/ folder are embedded in the qvf file.

schemas MediaListDef object

Defines the list of media files.

This struct is deprecated.

Properties

"qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

schemas MediaListItem object

In addition, this structure can return dynamic properties.

Properties

  • qUrlDef string

    Relative path to the media file. The URL is static. Media files located:

    • in the /content/default/ folder are outside the qvf file.
    • in the /media/ folder are embedded in the qvf file.
  • qUrl string

    Relative path to the media file. Media files located:

    • in the /content/default/ folder are outside the qvf file.
    • in the /media/ folder are embedded in the qvf file.

schemas MetaData object

Properties

  • qShared boolean
  • qUtcModifyTime number

    format = double

  • qSheetId string
  • qTemporary boolean
  • qRestrictedAccess boolean
  • qAccessList array of strings
  • qPersonalEditionHash_OBSOLETE string
  • qHidden boolean

    default = false

  • qLinkedTo array of strings

schemas NxAppLayout object

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted. The persisted dynamic properties are the following:

  • modifiedDate
  • published
  • publishTime
  • privileges
  • description
  • dynamicColor

Properties

  • qTitle string

    Title of the app.

  • qFileName string

    In Qlik Sense Enterprise, this property corresponds to the app identifier (GUID). In Qlik Sense Desktop, this property corresponds to the full path of the app.

  • qLastReloadTime string

    Date and time of the last reload of the app in ISO format.

  • qModified boolean

    Is set to true if the app has been updated since the last save.

  • qHasScript boolean

    Is set to true if a script is defined in the app.

  • qStateNames array of strings

    Array of alternate states.

  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qLocaleInfo object
    Show qLocaleInfo properties
    • qDecimalSep string

      Decimal separator.

    • qThousandSep string

      Thousand separator.

    • qListSep string

      List separator.

    • qMoneyDecimalSep string

      Money decimal separator.

    • qMoneyThousandSep string

      Money thousand separator.

    • qCurrentYear integer

      Current year.

      format = int32

    • qMoneyFmt string

      Money format. Example: #.##0,00 kr;-#.##0,00 kr

    • qTimeFmt string

      Time format. Example: hh:mm:ss

    • qDateFmt string

      Date format. Example: YYYY-MM-DD

    • qTimestampFmt string

      Time stamp format. Example: YYYY-MM-DD hh:mm:ss[.fff]

    • qCalendarStrings object
      Show qCalendarStrings properties
      • qDayNames array of strings

        List of short day names.

      • qMonthNames array of strings

        List of short month names.

      • qLongDayNames array of strings

        List of long day names.

      • qLongMonthNames array of strings

        List of long month names.
    • qFirstWeekDay integer

      First day of the week, starting from 0. According to ISO 8601, Monday is the first day of the week.

      • 0 = Monday
      • 1 = Tuesday
      • ...
      • 6 = Sunday

      If this property has not been set in a script, the returned value comes from the Windows operating system.

      format = int32

    • qBrokenWeeks boolean

      Is set to true if broken weeks are allowed in a year. According to ISO 8601, no broken weeks should be allowed. This property is not shown if set to false. If qBrokenWeeks is set to true, qReferenceDay is irrelevant. If this property has not been set in a script, the returned value comes from the Windows operating system.

    • qReferenceDay integer

      Day in the year that is always in week 1. According to ISO 8601, January 4th should always be part of the first week of the year ( qReferenceDay =4). Recommended values are in the range 1 and 7. If this property has not been set in a script, the returned value comes from the Windows operating system. This property is not relevant if there are broken weeks in the year.

      format = int32

    • qFirstMonthOfYear integer

      First month of the year, starting from 1. According to ISO 8601, January is the first month of the year.

      • 1 = January
      • 2 = February
      • 12 = January

      If this property has not been set in a script, the returned value comes from the Windows operating system.

      format = int32

    • qCollation string

      Locale name (following language tagging convention RFC 4646): < language>-<REGION> Where:

      • language is a lowercase ISO  639 language code
      • REGION specifies an uppercase ISO 3166 country code.

      If this property has not been set in a script, the returned value comes from the Windows operating system.

    • qNumericalAbbreviation string

      Number format. Example: 3:k;6:M;9:G;12:T;15:P;18:E;21:Z;24:Y;-3:m;-6:μ;-9:n;-12:p;-15:f;-18:a;-21:z;-24:y
  • qHasData boolean

    Is set to true if the app contains data following a script reload.

  • qReadOnly boolean

    If set to true, it means that the app is read-only.

  • qIsOpenedWithoutData boolean

    If set to true, it means that the app was opened without loading its data.

  • qIsSessionApp boolean

    If set to true, the app is a Session App, i.e. not persistent.

  • qProhibitBinaryLoad boolean

    When true, the persisted app cannot be used in a Binary load statement in a Qlik load script.

  • qThumbnail object
    In addition, this structure can return dynamic properties.
    Show qThumbnail properties
    • qUrl string

      Relative path of the thumbnail.
  • qIsBDILiveMode boolean

    If set to true, the app is in BDI Direct Query Mode.

  • qIsDirectQueryMode boolean

    If set to true, the app is in Direct Query Mode.

  • qUnsupportedFeatures array of strings

    Array of features not supported by the app.

    Values may be any of: "binningData""bookmarks""calculatedFields""continuousData""invertedSelections""rangeSelections""reducingData""search""selectionCount""selectionInsights""tableMiniChart""trendlines""calculatedDimensions""includeZeroValues""includeNullValues""filterPanePaging""filterPaneCustomSorting""showFrequency""limitation""totals"

  • qUsage string

    Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"

schemas NxAppProperties object

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted. The persisted dynamic properties are the following:

  • modifiedDate
  • published
  • publishTime
  • privileges
  • description
  • dynamicColor

Properties

  • qTitle string

    App title.

  • qLastReloadTime string

    Last reload time of the app.

  • qMigrationHash string

    Internal property reserved for app migration. Patch version of the app. Do not update.

  • qSavedInProductVersion string

    Internal property reserved for app migration. The app is saved in this version of the product. Do not update.

  • qThumbnail object
    In addition, this structure can contain dynamic properties.
    Show qThumbnail properties
    • qUrl string

      Relative path of the thumbnail.
  • qHasSectionAccess boolean

    If true the app has section access configured.

  • qUsage string

    Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"

schemas NxAttrDimDef object

Layout for NxAttrDimDef.

Properties

  • qDef string

    Expression or field name.

  • qLibraryId string

    LibraryId for dimension.

  • qSortBy object
    Show qSortBy properties
    • qSortByState integer

      Sorts the field values according to their logical state (selected, optional, alternative or excluded).

      format = int8

    • qSortByFrequency integer

      Sorts the field values by frequency (number of occurrences in the field).

      format = int8

    • qSortByNumeric integer

      Sorts the field values by numeric value.

      format = int8

    • qSortByAscii integer

      Sorts the field by alphabetical order.

      format = int8

    • qSortByLoadOrder integer

      Sorts the field values by the initial load order.

      format = int8

    • qSortByExpression integer

      Sorts the field by expression.

      format = int8

    • qExpression object
      Show qExpression properties
      • qv string

        Expression evaluated to dual.
    • qSortByGreyness integer

      format = int8

  • qAttribute boolean

    If set to true, this attribute will not affect the number of rows in the cube.

schemas NxAttrDimInfo object

Layout for NxAttrDimDef.

Properties

  • qCardinal integer

    Cardinality of the attribute expression.

    format = int32

  • qSize object
    Show qSize properties
    • qcx integer

      Number of pixels on the x axis.

      format = int32

    • qcy integer

      Number of pixels on the y axis.

      format = int32

  • qFallbackTitle string

    The title for the attribute dimension.

  • qLocked boolean

    The Locked value of the dimension.

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.
  • qIsCalculated boolean

    True if this is a calculated dimension.

    default = false

schemas NxAttrExprDef object

Properties

  • qExpression string

    Definition of the attribute expression. Example: "Max(OrderID)"

  • qLibraryId string

    Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

  • qAttribute boolean

    If set to true, this measure will not affect the number of rows in the cube.

  • qNumFormat object

    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:

    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.

    Show qNumFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qLabel string

    Label of the attribute expression.

  • qLabelExpression string

    Optional expression used for dynamic label.

schemas NxAttrExprInfo object

Layout for NxAttrExprDef.

Properties

  • qMin number

    Minimum value.

    format = double

  • qMax number

    Maximum value.

    format = double

  • qFallbackTitle string
  • qMinText string

    String version of the minimum Value.

  • qMaxText string

    String version of the maximum Value.

  • qNumFormat object

    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:

    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.

    Show qNumFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • 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 expression.

schemas NxAttributeDimValues object

Properties

  • qValues array of objects

    List of values.

    Show qValues properties
    • qText string

      Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

    • qElemNo integer

      Element number.

      format = int32

schemas NxAttributeExpressionValues object

Properties

  • qValues array of objects

    List of attribute expressions values.

    Show qValues properties
    • qText string

      Text related to the attribute expression value.

    • qNum number

      Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

      format = double

schemas NxAutoSortByStateDef object

Properties

  • qDisplayNumberOfRows integer

    This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

    format = int32

schemas NxAxisData object

Properties

  • qAxis array of objects

    List of axis data.

    Show qAxis properties
    • qName string

      Name of the derived definition.

    • qTags array of strings

      List of tags.

    • qTicks array of objects

      List of ticks.

      Show qTicks properties
      • qText string

        Tick's label.

      • qStart number

        Start value.

        format = double

      • qEnd number

        End value.

        format = double

schemas NxAxisTicks object

Properties

  • qName string

    Name of the derived definition.

  • qTags array of strings

    List of tags.

  • qTicks array of objects

    List of ticks.

    Show qTicks properties
    • qText string

      Tick's label.

    • qStart number

      Start value.

      format = double

    • qEnd number

      End value.

      format = double

schemas NxBookmark object

Properties

  • qStateData array of objects

    List of selections for each state.

    Show qStateData properties
    • qStateName string

      Name of the alternate state. Default is current selections: $

    • qFieldItems array of objects

      List of the selections.

      Show qFieldItems properties
      • qDef object
        Show qDef properties
        • qName string

          Name of the field.

        • qType string

          Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

      • qLocked boolean

        Indicates if the field is locked. Default is false.

      • qSelectInfo object
        Show qSelectInfo properties
        • qTextSearch string

          Text search string. Everything that matches the text is selected. This parameter is optional.

        • qRangeLo number

          Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

          default = -1e+300, format = double, default = -1e+300

        • qRangeHi number

          Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

          default = -1e+300, format = double, default = -1e+300

        • qNumberFormat object

          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:

          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.

          Show qNumberFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRangeInfo array of objects

          This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

          Show qRangeInfo properties
          • qRangeLo number

            Lowest value in the range.

            default = -1e+300, format = double, default = -1e+300

          • qRangeHi number

            Highest value in the range.

            default = -1e+300, format = double, default = -1e+300

          • qMeasure string

            Label of the measure.
        • qSoftLock boolean

          Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

          default = false

        • qContinuousRangeInfo array of objects

          List of information about ranges for selections.

          Show qContinuousRangeInfo properties
          • qMin number

            Lowest value in the range

            format = double

          • qMax number

            Highest value in the range

            format = double

          • qMinInclEq boolean

            If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

          • qMaxInclEq boolean

            If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
        • qSelectFieldSearch boolean

          This parameter is true if the TextSearch is a result of a Select Field operation.

          default = false

      • qValues array of objects
        Show qValues properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qExcludedValues array of objects

        List of excluded values. Either the list of selected values or the list of excluded values is displayed.

        Show qExcludedValues properties
        • qText string

          Text related to the field value. This parameter is optional.

        • qIsNumeric boolean

          Is set to true if the value is a numeric. This parameter is optional. Default is false.

        • qNumber number

          Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

          format = double

      • qAndMode boolean

        If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

      • qOneAndOnlyOne boolean

        If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

      • qValuesCount integer

        Count of selected values. Indicates if the Values field is loaded.

        default = -1, format = int32, default = -1

      • qExcludedValuesCount integer

        Count of excluded values. Indicates if the ExcludedValues field is loaded.

        default = -1, format = int32, default = -1

  • qUtcModifyTime number

    Time when the bookmark was created.

    format = double

  • qVariableItems array of objects

    List of the variables in the app at the time the bookmark was created.

    Show qVariableItems properties
    • qName string

      Name of the variable.

    • qValue object
      Show qValue properties
      • qText string

        Text related to the field value. This parameter is optional.

      • qIsNumeric boolean

        Is set to true if the value is a numeric. This parameter is optional. Default is false.

      • qNumber number

        Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

        format = double

    • qDefinition string

      The Reporting mode definition of the variable.
  • qPatches array of objects

    Softpatches to be applied with this bookmark.

    Show qPatches properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qPatches array of objects

      Array with patches.

      Show qPatches properties
      • qOp string

        Can be one of: "add""remove""replace"

      • qPath string

        Path to the property to add, remove or replace.

      • qValue string

        This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
    • qChildren array of undefineds

      Array with child objects and their patches.
  • qCyclicGroupStates array of objects

    Information about cyclic groups by zero-based index. This field is unused.

    Show qCyclicGroupStates properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qActiveField integer

      Active field of the cyclic group, identified by a zero-based index.

      format = int32

  • qGroupStates array of objects
    Experimental

    Information about cyclic groups indexed by field definition.

    Show qGroupStates properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qActiveFieldDef string

      String defining the active field.

schemas NxCalcCond object

Properties

  • qCond object
    Show qCond properties
    • qv string

      Expression evaluated to dual.
  • qMsg object
    Show qMsg properties
    • qv string

      Expression evaluated to string.

schemas NxCardinalities object

Properties

  • qCardinal integer

    Number of distinct field values.

    format = int32

  • qHypercubeCardinal integer

    Number of distinct hypercube values.

    format = int32

  • qAllValuesCardinal integer

    Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

    default = -1, format = int32, default = -1

schemas NxCell object

Properties

  • qText string

    Some text. This parameter is optional.

  • qNum number

    A value. This parameter is optional.

    format = double

  • qElemNumber integer

    Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

    • -1: the cell is a Total cell. It shows a total.
    • -2: the cell is a Null cell.
    • -3: the cell belongs to the group Others .
    • -4: the cell is empty. Applies to pivot tables.

    format = int32

  • qState string

    Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

  • qIsEmpty boolean

    Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

  • qIsTotalCell boolean

    Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

  • qIsOtherCell boolean

    Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

  • qFrequency string

    Frequency of the value. This parameter is optional.

  • qHighlightRanges object
    Show qHighlightRanges properties
    • qRanges array of objects

      Ranges of highlighted values.

      Show qRanges properties
      • qCharPos integer

        Position of the first search occurrence.

        format = int32

      • qCharCount integer

        Number of occurrences found.

        format = int32

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDims object
    Show qAttrDims properties
    • qValues array of objects

      List of values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNo integer

        Element number.

        format = int32

  • qIsNull boolean

    Is set to true if the value is Null.

  • qMiniChart object
    Show qMiniChart properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

    • qMin number

      format = double

    • qMax number

      format = double

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
  • qInExtRow boolean

schemas NxCellPosition object

Properties

  • qx integer

    Position of the cell on the x-axis.

    format = int32

  • qy integer

    Position of the cell on the y-axis.

    format = int32

schemas NxCellRows object[]

Element properties

  • qText string

    Some text. This parameter is optional.

  • qNum number

    A value. This parameter is optional.

    format = double

  • qElemNumber integer

    Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

    • -1: the cell is a Total cell. It shows a total.
    • -2: the cell is a Null cell.
    • -3: the cell belongs to the group Others .
    • -4: the cell is empty. Applies to pivot tables.

    format = int32

  • qState string

    Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

  • qIsEmpty boolean

    Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

  • qIsTotalCell boolean

    Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

  • qIsOtherCell boolean

    Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

  • qFrequency string

    Frequency of the value. This parameter is optional.

  • qHighlightRanges object
    Show qHighlightRanges properties
    • qRanges array of objects

      Ranges of highlighted values.

      Show qRanges properties
      • qCharPos integer

        Position of the first search occurrence.

        format = int32

      • qCharCount integer

        Number of occurrences found.

        format = int32

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDims object
    Show qAttrDims properties
    • qValues array of objects

      List of values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNo integer

        Element number.

        format = int32

  • qIsNull boolean

    Is set to true if the value is Null.

  • qMiniChart object
    Show qMiniChart properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

    • qMin number

      format = double

    • qMax number

      format = double

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
  • qInExtRow boolean

schemas NxContainerEntry object

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qData object

    Contains dynamic JSON data specified by the client.

schemas NxContinuousDataOptions object

Properties

  • qStart number

    Start value.

    format = double

  • qEnd number

    End value.

    format = double

  • qNbrPoints integer

    Number of bins for binning.

    format = int32

  • qMaxNbrTicks integer

    Maximum number of ticks.

    format = int32

  • qMaxNumberLines integer

    Maximum number of lines.

    default = -1, format = int32, default = -1

schemas NxContinuousMode string

oneOf

  • Never

    CONTINUOUS_NEVER

  • Possible

    CONTINUOUS_IF_POSSIBLE

  • Time

    CONTINUOUS_IF_TIME

schemas NxContinuousRangeSelectInfo object

Properties

  • qRange object
    Show qRange properties
    • qMin number

      Lowest value in the range

      format = double

    • qMax number

      Highest value in the range

      format = double

    • qMinInclEq boolean

      If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

    • qMaxInclEq boolean

      If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
  • qDimIx integer

    Dimension index.

    format = int32

schemas NxCurrentSelectionItem object

Properties

  • qTotal integer

    Number of values in the field.

    format = int32

  • qIsNum boolean

    This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional.

  • qField string

    Name of the field that is selected.

  • qLocked boolean

    This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional.

  • qOneAndOnlyOne boolean

    This parameter is displayed if its value is true. Property that is set to a field. Is set to true if the field cannot be unselected. This parameter is optional.

  • qTextSearch string

    Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional.

  • qSelectedCount integer

    Number of values that are selected.

    format = int32

  • qSelected string

    Values that are selected.

  • qRangeInfo array of objects

    Information about the range of selected values. Is empty if there is no range of selected values.

    Show qRangeInfo properties
    • qRangeLo number

      Lowest value in the range.

      default = -1e+300, format = double, default = -1e+300

    • qRangeHi number

      Highest value in the range.

      default = -1e+300, format = double, default = -1e+300

    • qMeasure string

      Label of the measure.
  • qSortIndex integer

    Sort index of the field. Indexing starts from 0.

    format = int32

  • qStateCounts object
    Show qStateCounts properties
    • qLocked integer

      Number of values in locked state.

      format = int32

    • qSelected integer

      Number of values in selected state.

      format = int32

    • qOption integer

      Number of values in optional state.

      format = int32

    • qDeselected integer

      Number of values in deselected state.

      format = int32

    • qAlternative integer

      Number of values in alternative state.

      format = int32

    • qExcluded integer

      Number of values in excluded state.

      format = int32

    • qSelectedExcluded integer

      Number of values in selected excluded state.

      format = int32

    • qLockedExcluded integer

      Number of values in locked excluded state.

      format = int32

  • qSelectedFieldSelectionInfo array of objects

    Information about the fields that are selected.

    Show qSelectedFieldSelectionInfo properties
    • qName string

      Name of the field.

    • qFieldSelectionMode string

      Can be one of: "NORMAL""AND""NOT"

  • qNotSelectedFieldSelectionInfo array of objects

    Information about the fields that are not selected.

    Show qNotSelectedFieldSelectionInfo properties
    • qName string

      Name of the field.

    • qFieldSelectionMode string

      Can be one of: "NORMAL""AND""NOT"

  • qSelectionThreshold integer

    Maximum values to show in the current selections. The default value is 6.

    format = int32

  • qReadableName string

    Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly.

  • qIsHidden boolean

    Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden.

  • qDimensionReferences array of objects
    Experimental

    List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem.

    Show qDimensionReferences properties
    • qId string

      Identifier of the associated dimension.

    • qLabel string

      Text label.

schemas NxDataAreaPage object

Properties

  • qLeft number

    Position from the left. Corresponds to the lowest possible value of the first measure (the measure on the x-axis).

    format = double

  • qTop number

    Position from the top. Corresponds to the highest possible value of the second measure (the measure on the y-axis).

    format = double

  • qWidth number

    Width of the page. Corresponds to the highest possible value of the first measure (the measure on the x-axis).

    format = double

  • qHeight number

    Height of the page. The difference between qTop and qHeight gives the lowest possible value of the second measure (the measure on the y-axis).

    format = double

schemas NxDataPage object

Properties

  • qMatrix array of arrays

    Array of data.

    Show qMatrix properties
    • qText string

      Some text. This parameter is optional.

    • qNum number

      A value. This parameter is optional.

      format = double

    • qElemNumber integer

      Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

      • -1: the cell is a Total cell. It shows a total.
      • -2: the cell is a Null cell.
      • -3: the cell belongs to the group Others .
      • -4: the cell is empty. Applies to pivot tables.

      format = int32

    • qState string

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qIsEmpty boolean

      Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

    • qIsTotalCell boolean

      Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

    • qIsOtherCell boolean

      Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

    • qFrequency string

      Frequency of the value. This parameter is optional.

    • qHighlightRanges object
      Show qHighlightRanges properties
      • qRanges array of objects

        Ranges of highlighted values.

        Show qRanges properties
        • qCharPos integer

          Position of the first search occurrence.

          format = int32

        • qCharCount integer

          Number of occurrences found.

          format = int32

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

    • qIsNull boolean

      Is set to true if the value is Null.

    • qMiniChart object
      Show qMiniChart properties
      • qMatrix array of arrays

        Array of data.

        Show qMatrix properties
        • qText string

          Some text.

        • qNum number

          A value. This parameter is optional.

          format = double

        • qElemNumber integer

          Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

          • -1: the cell is a Total cell. It shows a total.
          • -2: the cell is a Null cell.
          • -3: the cell belongs to the group Others .
          • -4: the cell is empty. Applies to pivot tables.

          format = int32

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

      • qMin number

        format = double

      • qMax number

        format = double

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
    • qInExtRow boolean
  • qTails array of objects

    Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

    Show qTails properties
    • qUp integer

      Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

      format = int32

    • qDown integer

      Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

      format = int32

  • qArea object
    Show qArea properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qIsReduced boolean

    Is set to true, if the data have been reduced. The default value is false.

    default = false

schemas NxDataReductionMode string

oneOf

  • N

    DATA_REDUCTION_NONE

  • D1

    DATA_REDUCTION_ONEDIM

  • S

    DATA_REDUCTION_SCATTERED

  • C

    DATA_REDUCTION_CLUSTERED

  • ST

    DATA_REDUCTION_STACKED

schemas NxDerivedField object

Properties

  • qId string

    Identifier of the derived field. The identifier is unique.

  • qName string

    Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year

  • qMethod string

    Method name associated to the derived field.

  • qExpr string

    Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year , the expression is as follows: =${Mydefinition(OrderDate).Year}

  • qTags array of strings

    List of tags.

schemas NxDerivedFieldDescriptionList object

Properties

  • qDerivedFieldLists array of objects

    Information about the derived fields.

    Show qDerivedFieldLists properties
    • qDerivedDefinitionName string

      Name of the derived definition.

    • qFieldDefs array of objects

      List of the derived fields.

      Show qFieldDefs properties
      • qId string

        Identifier of the derived field. The identifier is unique.

      • qName string

        Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year

      • qMethod string

        Method name associated to the derived field.

      • qExpr string

        Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year , the expression is as follows: =${Mydefinition(OrderDate).Year}

      • qTags array of strings

        List of tags.
    • qGroupDefs array of objects

      List of the derived groups.

      Show qGroupDefs properties
      • qId string

        Identifier of the group.

      • qName string

        Name of the derived group.

      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        List of the derived fields in the group.
    • qTags array of strings

      List of tags on the derived fields.

schemas NxDerivedFieldsData object

Properties

  • qDerivedDefinitionName string

    Name of the derived definition.

  • qFieldDefs array of objects

    List of the derived fields.

    Show qFieldDefs properties
    • qId string

      Identifier of the derived field. The identifier is unique.

    • qName string

      Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year

    • qMethod string

      Method name associated to the derived field.

    • qExpr string

      Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year , the expression is as follows: =${Mydefinition(OrderDate).Year}

    • qTags array of strings

      List of tags.
  • qGroupDefs array of objects

    List of the derived groups.

    Show qGroupDefs properties
    • qId string

      Identifier of the group.

    • qName string

      Name of the derived group.

    • qGrouping string

      Can be one of: "N""H""C"

    • qFieldDefs array of strings

      List of the derived fields in the group.
  • qTags array of strings

    List of tags on the derived fields.

schemas NxDerivedGroup object

Properties

  • qId string

    Identifier of the group.

  • qName string

    Name of the derived group.

  • qGrouping string

    Can be one of: "N""H""C"

  • qFieldDefs array of strings

    List of the derived fields in the group.

schemas NxDimCellType string

oneOf

  • V

    NX_DIM_CELL_VALUE

  • E

    NX_DIM_CELL_EMPTY

  • N

    NX_DIM_CELL_NORMAL

  • T

    NX_DIM_CELL_TOTAL

  • O

    NX_DIM_CELL_OTHER

  • A

    NX_DIM_CELL_AGGR

  • P

    NX_DIM_CELL_PSEUDO

  • R

    NX_DIM_CELL_ROOT

  • U

    NX_DIM_CELL_NULL

  • G

    NX_DIM_CELL_GENERATED

schemas NxDimension object

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.

Properties

  • qLibraryId string

    Refers to a dimension stored in the library.

  • qDef object
    Show qDef properties
    • qGrouping string

      Can be one of: "N""H""C"

    • qFieldDefs array of strings

      Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

    • qFieldLabels array of strings

      Array of field labels. This parameter is optional.

    • qSortCriterias array of objects

      Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

      Show qSortCriterias properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qNumberPresentations array of objects

      Defines the format of the value. This parameter is optional.

      Show qNumberPresentations properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qReverseSort boolean

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

    • qActiveField integer

      Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

      format = int32

    • qLabelExpression string

      Label expression. This parameter is optional.

    • qAlias string

      Alias of the dimension.
  • qNullSuppression boolean

    If set to true, no null values are returned.

  • qIncludeElemValue boolean
  • qOtherTotalSpec object
    Show qOtherTotalSpec properties
    • qOtherMode string

      Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

    • qOtherCounted object
      Show qOtherCounted properties
      • qv string

        Expression evaluated to dual.
    • qOtherLimit object
      Show qOtherLimit properties
      • qv string

        Expression evaluated to dual.
    • qOtherLimitMode string

      Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

    • qSuppressOther boolean

      If set to true, the group Others is not displayed as a dimension value. The default value is false.

      default = false

    • qForceBadValueKeeping boolean

      This parameter is used when qOtherMode is set to:

      • OTHER_ABS_LIMITED
      • OTHER_REL_LIMITED
      • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

      and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

      default = true

    • qApplyEvenWhenPossiblyWrongResult boolean

      Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

      default = true

    • qGlobalOtherGrouping boolean

      This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

      default = false

    • qOtherCollapseInnerDimensions boolean

      If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

      default = false

    • qOtherSortMode string

      Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

    • qTotalMode string

      Can be one of: "TOTAL_OFF""TOTAL_EXPR"

    • qReferencedExpression object
      Show qReferencedExpression properties
      • qv string

        Expression evaluated to string.
  • qShowTotal boolean
  • qShowAll boolean

    If set to true, all dimension values are shown.

  • qOtherLabel object
    Show qOtherLabel properties
    • qv string

      Expression evaluated to string.
  • qTotalLabel object
    Show qTotalLabel properties
    • qv string

      Expression evaluated to string.
  • qCalcCond object
    Show qCalcCond properties
    • qv string

      Expression evaluated to dual.
  • qAttributeExpressions array of objects

    List of attribute expressions.

    Show qAttributeExpressions properties
    • qExpression string

      Definition of the attribute expression. Example: "Max(OrderID)"

    • qLibraryId string

      Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

    • qAttribute boolean

      If set to true, this measure will not affect the number of rows in the cube.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qLabel string

      Label of the attribute expression.

    • qLabelExpression string

      Optional expression used for dynamic label.
  • qAttributeDimensions array of objects

    List of attribute dimensions.

    Show qAttributeDimensions properties
    • qDef string

      Expression or field name.

    • qLibraryId string

      LibraryId for dimension.

    • qSortBy object
      Show qSortBy properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qAttribute boolean

      If set to true, this attribute will not affect the number of rows in the cube.
  • qCalcCondition object
    Show qCalcCondition properties
    • qCond object
      Show qCond properties
      • qv string

        Expression evaluated to dual.
    • qMsg object
      Show qMsg properties
      • qv string

        Expression evaluated to string.

schemas NxDimensionInfo object

Properties

  • qFallbackTitle string

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

  • qApprMaxGlyphCount integer

    Length of the longest value in the field.

    format = int32

  • qCardinal integer Deprecated

    Number of distinct field values.

    format = int32

  • qLocked boolean

    Is set to true if the field is locked.

  • qSortIndicator string

    Can be one of: "N""A""D"

  • qGroupFallbackTitles array of strings

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

  • qGroupPos integer

    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.

    format = int32

  • qStateCounts object
    Show qStateCounts properties
    • qLocked integer

      Number of values in locked state.

      format = int32

    • qSelected integer

      Number of values in selected state.

      format = int32

    • qOption integer

      Number of values in optional state.

      format = int32

    • qDeselected integer

      Number of values in deselected state.

      format = int32

    • qAlternative integer

      Number of values in alternative state.

      format = int32

    • qExcluded integer

      Number of values in excluded state.

      format = int32

    • qSelectedExcluded integer

      Number of values in selected excluded state.

      format = int32

    • qLockedExcluded integer

      Number of values in locked excluded state.

      format = int32

  • qTags array of strings

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

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.
  • qDimensionType string

    Can be one of: "D""N""T"

  • qReverseSort boolean

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

  • qGrouping string

    Can be one of: "N""H""C"

  • qIsSemantic boolean

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

  • qNumFormat object

    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:

    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.

    Show qNumFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • 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.

  • qGroupFieldDefs array of strings

    Array of field names.

  • qMin number

    Minimum value.

    format = double

  • qMax number

    Maximum value.

    format = double

  • qContinuousAxes boolean

    Is continuous axis used.

  • qIsCyclic boolean

    Is a cyclic dimension used.

  • qDerivedField boolean

    Is derived field is used as a dimension.

  • qAttrExprInfo array of objects

    Array of attribute expressions.

    Show qAttrExprInfo properties
    • qMin number

      Minimum value.

      format = double

    • qMax number

      Maximum value.

      format = double

    • qFallbackTitle string
    • qMinText string

      String version of the minimum Value.

    • qMaxText string

      String version of the maximum Value.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • 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 expression.
  • qAttrDimInfo array of objects

    Array of attribute dimensions.

    Show qAttrDimInfo properties
    • qCardinal integer

      Cardinality of the attribute expression.

      format = int32

    • qSize object
      Show qSize properties
      • qcx integer

        Number of pixels on the x axis.

        format = int32

      • qcy integer

        Number of pixels on the y axis.

        format = int32

    • qFallbackTitle string

      The title for the attribute dimension.

    • qLocked boolean

      The Locked value of the dimension.

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qIsCalculated boolean

      True if this is a calculated dimension.

      default = false

  • qCalcCondMsg string

    The message displayed if calculation condition is not fulfilled.

  • qIsCalculated boolean

    True if this is a calculated dimension.

    default = false

  • qIsOneAndOnlyOne boolean

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

  • qCardinalities object
    Show qCardinalities properties
    • qCardinal integer

      Number of distinct field values.

      format = int32

    • qHypercubeCardinal integer

      Number of distinct hypercube values.

      format = int32

    • qAllValuesCardinal integer

      Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

      default = -1, format = int32, default = -1

  • qLibraryId string

    Refers to a dimension stored in the library.

  • qEffectiveDimensionName string
    Experimental

    The expanded and stripped dimension name used internally in engine.

schemas NxDimensionType string

oneOf

  • D

    NX_DIMENSION_TYPE_DISCRETE

  • N

    NX_DIMENSION_TYPE_NUMERIC

  • T

    NX_DIMENSION_TYPE_TIME

schemas NxDownloadInfo object

Properties

  • qUrl string

    URL to download the reduced app on.

  • qFileSize integer

    The filesize of the reduced app.

    default = -1, format = int32, default = -1

schemas NxDownloadOptions object

Properties

  • qBookmarkId string

    Bookmark Id to apply before reducing the application.

  • qExpires integer

    Time in seconds for how long the download link is valid.

    default = 3600, format = int32, default = 3600

  • qServeOnce boolean

    default = false

schemas NxEngineVersion object

Properties

  • qComponentVersion string

    Version number of the Qlik engine component.

schemas NxExportFileType string

oneOf

  • CSV_C

    EXPORT_CSV_C

  • CSV_T

    EXPORT_CSV_T

  • OOXML

    EXPORT_OOXML

  • PARQUET

    EXPORT_PARQUET

schemas NxExportState string

oneOf

  • P

    EXPORT_POSSIBLE

  • A

    EXPORT_ALL

schemas NxFeature string

oneOf

  • binningData

    FEATURE_BINNING_DATA

  • bookmarks

    FEATURE_BOOKMARKS

  • calculatedFields

    FEATURE_CALCULATED_FIELDS

  • continuousData

    FEATURE_CONTINUOUS_DATA

  • invertedSelections

    FEATURE_INVERTED_SELECTIONS

  • rangeSelections

    FEATURE_RANGE_SELECTIONS

  • reducingData

    FEATURE_REDUCING_DATA

  • search

    FEATURE_SEARCH

  • selectionCount

    FEATURE_SELECTION_COUNT

  • selectionInsights

    FEATURE_SELECTION_INSIGHTS

  • tableMiniChart

    FEATURE_TABLE_MINI_CHART

  • trendlines

    FEATURE_TRENDLINES

  • calculatedDimensions

    FEATURE_CALCULATED_DIMENSIONS

  • includeZeroValues

    FEATURE_INCLUDE_ZERO_VALUES

  • includeNullValues

    FEATURE_INCLUDE_NULL_VALUES

  • filterPanePaging

    FEATURE_FILTER_PANE_PAGING

  • filterPaneCustomSorting

    FEATURE_FILTER_PANE_CUSTOM_SORTING

  • showFrequency

    FEATURE_SHOW_FREQUENCY

  • limitation

    FEATURE_LIMITATION

  • totals

    FEATURE_TOTALS

schemas NxFieldDescription object

NxDerivedFieldsdata

Name Description Type
qDerivedDefinitionName Name of the derived definition. String
qFieldDefs List of the derived fields. Array of NxDerivedField
qGroupDefs List of the derived groups. Array of NxDerivedGroup
qTags List of tags on the derived fields. Array of String

Properties

  • qIsSemantic boolean

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

  • qIsHidden boolean

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

  • qIsSystem boolean

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

  • qAndMode boolean

    If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.

  • qName string

    Name of the field

  • qCardinal integer

    Number of distinct field values

    format = int32

  • qTags array of strings

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

  • qIsDefinitionOnly boolean

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

  • qDerivedFieldData object
    Show qDerivedFieldData properties
    • qDerivedFieldLists array of objects

      Information about the derived fields.

      Show qDerivedFieldLists properties
      • qDerivedDefinitionName string

        Name of the derived definition.

      • qFieldDefs array of objects

        List of the derived fields.

        Show qFieldDefs properties
        • qId string

          Identifier of the derived field. The identifier is unique.

        • qName string

          Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year

        • qMethod string

          Method name associated to the derived field.

        • qExpr string

          Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year , the expression is as follows: =${Mydefinition(OrderDate).Year}

        • qTags array of strings

          List of tags.
      • qGroupDefs array of objects

        List of the derived groups.

        Show qGroupDefs properties
        • qId string

          Identifier of the group.

        • qName string

          Name of the derived group.

        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          List of the derived fields in the group.
      • qTags array of strings

        List of tags on the derived fields.
  • qIsDetail boolean

    Is used for Direct Discovery. If set to true, it means that the type of the field is detail.

  • qIsImplicit boolean

    Is used for Direct Discovery. If set to true, it means that the type of the field is measure.

  • qReadableName string

schemas NxFieldProperties object

Properties

  • qOneAndOnlyOne boolean

    This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.

    The property _OneAndOnlyOne_ can be set to true if one and only value has been selected in the field prior to setting the property.

schemas NxFieldResourceId object

Properties

  • qName string

    Name of the field to get the resource id for.

  • qResourceIds array of objects

    Field level resource Id per table that the field is part of

    Show qResourceIds properties
    • qTable string

      Name of the table that the field belongs to get the resource id for

    • qResourceId string

      Resource identifier for the field

schemas NxFieldSelectionInfo object

Properties

  • qName string

    Name of the field.

  • qFieldSelectionMode string

    Can be one of: "NORMAL""AND""NOT"

schemas NxFieldSelectionMode string

oneOf

  • NORMAL

    SELECTION_MODE_NORMAL

  • AND

    SELECTION_MODE_AND

  • NOT

    SELECTION_MODE_NOT

schemas NxFieldTableResourceId object

Properties

  • qTable string

    Name of the table that the field belongs to get the resource id for

  • qResourceId string

    Resource identifier for the field

schemas NxFrequencyMode string

oneOf

  • N

    NX_FREQUENCY_NONE

  • V

    NX_FREQUENCY_VALUE

  • P

    NX_FREQUENCY_PERCENT

  • R

    NX_FREQUENCY_RELATIVE

schemas NxGetBookmarkOptions object

Properties

  • qTypes array of strings

    List of object types.

  • qData object

    Contains dynamic JSON data specified by the client.

  • qIncludePatches boolean

    Include the bookmark patches. Patches can be very large and may make the list result unmanageable.

schemas NxGetObjectOptions object

Properties

  • qTypes array of strings

    List of object types.

  • qIncludeSessionObjects boolean

    Set to true to include session objects. The default value is false.

    default = false

  • qData object

    Contains dynamic JSON data specified by the client.

schemas NxGroupDef object

Experimental

Defines the properties of an object group.

Properties

  • qClass string

    Can be one of: "bookmark""object"

  • qObjectType string

    Specifies the type of the group's object members.

    default = "bookmark"

  • qGroupType string

    Specifies the type of the group's subgroup members.

    default = "objectgroup"

  • qLabel string

    The group's label. Will be evaluated as an expression if it starts with '='.

  • qIncludeOrphanGroups boolean

    Include all groups of the relevant type, by adding those groups last that are not explicitly included in the hierarchy (orphans)

  • qMemberIds array of objects
    Experimental

    The objects and sub-groups that are members of the group.

    Show qMemberIds properties
    • qGroupId string
    • qObjectId string

schemas NxGroupMemberClass string

oneOf

  • bookmark

    MEMBER_BOOKMARK

  • object

    MEMBER_OBJECT

schemas NxGroupObjectId object

Experimental

Holds the ID of a NxGroupDef's member. GroupId holds the ID of a sub-group while ObjectId holds the ID of an object. Only one Id should be set. GroupId takes precedence if both are set.

Properties

  • qGroupId string
  • qObjectId string

schemas NxGroupTail object

Properties

  • qUp integer

    Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

    format = int32

  • qDown integer

    Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

    format = int32

schemas NxGrpType string

oneOf

  • N

    GRP_NX_NONE

  • H

    GRP_NX_HIEARCHY

  • C

    GRP_NX_COLLECTION

schemas NxHighlightRanges object

Properties

  • qRanges array of objects

    Ranges of highlighted values.

    Show qRanges properties
    • qCharPos integer

      Position of the first search occurrence.

      format = int32

    • qCharCount integer

      Number of occurrences found.

      format = int32

schemas NxHypercubeMode string

oneOf

  • S

    DATA_MODE_STRAIGHT

  • P

    DATA_MODE_PIVOT

  • K

    DATA_MODE_PIVOT_STACK

  • T

    DATA_MODE_TREE

  • D

    DATA_MODE_DYNAMIC

schemas NxInfo object

Properties

  • qId string

    Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

  • qType string

    Type of the object. This parameter is mandatory.

schemas NxInlineDimensionDef object

Properties

  • qGrouping string

    Can be one of: "N""H""C"

  • qFieldDefs array of strings

    Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

  • qFieldLabels array of strings

    Array of field labels. This parameter is optional.

  • qSortCriterias array of objects

    Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

    Show qSortCriterias properties
    • qSortByState integer

      Sorts the field values according to their logical state (selected, optional, alternative or excluded).

      format = int8

    • qSortByFrequency integer

      Sorts the field values by frequency (number of occurrences in the field).

      format = int8

    • qSortByNumeric integer

      Sorts the field values by numeric value.

      format = int8

    • qSortByAscii integer

      Sorts the field by alphabetical order.

      format = int8

    • qSortByLoadOrder integer

      Sorts the field values by the initial load order.

      format = int8

    • qSortByExpression integer

      Sorts the field by expression.

      format = int8

    • qExpression object
      Show qExpression properties
      • qv string

        Expression evaluated to dual.
    • qSortByGreyness integer

      format = int8

  • qNumberPresentations array of objects

    Defines the format of the value. This parameter is optional.

    Show qNumberPresentations properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qReverseSort boolean

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

  • qActiveField integer

    Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

    format = int32

  • qLabelExpression string

    Label expression. This parameter is optional.

  • qAlias string

    Alias of the dimension.

schemas NxInlineMeasureDef object

Properties

  • qLabel string

    Name of the measure. An empty string is returned as a default value. This parameter is optional.

  • qDescription string

    Description of the measure. An empty string is returned as a default value. This parameter is optional.

  • qTags array of strings

    Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

  • qGrouping string

    Can be one of: "N""H""C"

  • qDef string

    Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

  • qNumFormat object

    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:

    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.

    Show qNumFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qRelative boolean

    If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

  • qBrutalSum boolean

    If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

  • qAggrFunc string

    Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

  • qAccumulate integer
    • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

    format = int32

  • qReverseSort boolean

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

  • qActiveExpression integer

    Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

    format = int32

  • qExpressions array of strings

    Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

  • qLabelExpression string

    Label expression. This parameter is optional.

schemas NxLTrendlineType string

oneOf

  • AVERAGE

    Average

  • LINEAR

    Linear

  • POLYNOMIAL2

    Polynomial2

  • POLYNOMIAL3

    Polynomial3

  • POLYNOMIAL4

    Polynomial4

  • EXPONENTIAL

    Exponential

  • POWER

    Power

  • LOG

    Logarithmic

schemas NxLayoutErrors object

Properties

  • qErrorCode integer

    Error code.

    format = int32

schemas NxLibraryDimension object

Properties

  • qGrouping string

    Can be one of: "N""H""C"

  • qFieldDefs array of strings

    Array of dimension names.

  • qFieldLabels array of strings

    Array of dimension labels.

  • qLabelExpression string
  • qAlias string

    Alias of the dimension.

  • qScriptGenerated boolean Deprecated
  • qOrigin string

    Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

schemas NxLibraryDimensionDef object

Properties

  • qGrouping string

    Can be one of: "N""H""C"

  • qFieldDefs array of strings

    Array of dimension names.

  • qFieldLabels array of strings

    Array of dimension labels.

  • qLabelExpression string
  • qAlias string

    Alias of the dimension.

  • qScriptGenerated boolean Deprecated

    default = false

  • qOrigin string

    Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

schemas NxLibraryMeasure object

Information about the library measure. Is the layout for NxLibraryMeasureDef.

Properties

  • qLabel string
  • qDef string
  • qGrouping string

    Can be one of: "N""H""C"

  • qExpressions array of strings
  • qActiveExpression integer

    format = int32

  • qLabelExpression string
  • qNumFormat object

    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:

    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.

    Show qNumFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qScriptGenerated boolean Deprecated
  • qOrigin string

    Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

schemas NxLibraryMeasureDef object

Properties

  • qLabel string

    Label of the measure.

  • qDef string

    Definition of the measure.

  • qGrouping string

    Can be one of: "N""H""C"

  • qExpressions array of strings

    Array of expressions.

  • qActiveExpression integer

    Index to the active expression in a measure.

    format = int32

  • qLabelExpression string

    Optional expression used for dynamic label.

  • qNumFormat object

    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:

    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.

    Show qNumFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qScriptGenerated boolean Deprecated

    default = false

  • qOrigin string

    Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

schemas NxLinkedObjectInfo object

Properties

  • qRootId string

    Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object.

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.

schemas NxListObjectExpression object

Properties

  • qExpr string

    Value of the expression.

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code.

      format = int32

schemas NxListObjectExpressionDef object

Properties

  • qExpr string

    Value of the expression.

  • qLibraryId string

    Refers to an expression stored in the library.

schemas NxLocalizedErrorCode string

oneOf

  • LOCERR_INTERNAL_ERROR

  • LOCERR_GENERIC_UNKNOWN

  • LOCERR_GENERIC_OK

  • LOCERR_GENERIC_NOT_SET

  • LOCERR_GENERIC_NOT_FOUND

  • LOCERR_GENERIC_ALREADY_EXISTS

  • LOCERR_GENERIC_INVALID_PATH

  • LOCERR_GENERIC_ACCESS_DENIED

  • LOCERR_GENERIC_OUT_OF_MEMORY

  • LOCERR_GENERIC_NOT_INITIALIZED

  • LOCERR_GENERIC_INVALID_PARAMETERS

  • LOCERR_GENERIC_EMPTY_PARAMETERS

  • LOCERR_GENERIC_INTERNAL_ERROR

  • LOCERR_GENERIC_CORRUPT_DATA

  • LOCERR_GENERIC_MEMORY_INCONSISTENCY

  • LOCERR_GENERIC_INVISIBLE_OWNER_ABORT

  • LOCERR_GENERIC_PROHIBIT_VALIDATE

  • LOCERR_GENERIC_ABORTED

  • LOCERR_GENERIC_CONNECTION_LOST

  • LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION

  • LOCERR_GENERIC_REST_CONNECTION_FAILURE

  • LOCERR_GENERIC_MEMORY_LIMIT_REACHED

  • LOCERR_GENERIC_NOT_IMPLEMENTED

  • LOCERR_GENERIC_ENGINE_TERMINATED

  • LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED

  • LOCERR_HTTP_400

  • LOCERR_HTTP_401

  • LOCERR_HTTP_402

  • LOCERR_HTTP_403

  • LOCERR_HTTP_404

  • LOCERR_HTTP_405

  • LOCERR_HTTP_406

  • LOCERR_HTTP_407

  • LOCERR_HTTP_408

  • LOCERR_HTTP_409

  • LOCERR_HTTP_410

  • LOCERR_HTTP_411

  • LOCERR_HTTP_412

  • LOCERR_HTTP_413

  • LOCERR_HTTP_414

  • LOCERR_HTTP_415

  • LOCERR_HTTP_416

  • LOCERR_HTTP_417

  • LOCERR_HTTP_422

  • LOCERR_HTTP_423

  • LOCERR_HTTP_429

  • LOCERR_HTTP_500

  • LOCERR_HTTP_501

  • LOCERR_HTTP_502

  • LOCERR_HTTP_503

  • LOCERR_HTTP_504

  • LOCERR_HTTP_505

  • LOCERR_HTTP_509

  • LOCERR_HTTP_COULD_NOT_RESOLVE_HOST

  • LOCERR_APP_ALREADY_EXISTS

  • LOCERR_APP_INVALID_NAME

  • LOCERR_APP_ALREADY_OPEN

  • LOCERR_APP_NOT_FOUND

  • LOCERR_APP_IMPORT_FAILED

  • LOCERR_APP_SAVE_FAILED

  • LOCERR_APP_CREATE_FAILED

  • LOCERR_APP_INVALID

  • LOCERR_APP_CONNECT_FAILED

  • LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE

  • LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE

  • LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION

  • LOCERR_APP_MIGRATION_FAILURE

  • LOCERR_APP_SCRIPT_MISSING

  • LOCERR_APP_EXPORT_FAILED

  • LOCERR_APP_SIZE_EXCEEDED

  • LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED

  • LOCERR_APP_NOT_OPEN

  • LOCERR_APP_EVENT_SOURCE_TIMEOUT

  • LOCERR_APP_SOFT_DELETED

  • LOCERR_CONNECTION_ALREADY_EXISTS

  • LOCERR_CONNECTION_NOT_FOUND

  • LOCERR_CONNECTION_FAILED_TO_LOAD

  • LOCERR_CONNECTION_FAILED_TO_IMPORT

  • LOCERR_CONNECTION_NAME_IS_INVALID

  • LOCERR_CONNECTION_MISSING_CREDENTIALS

  • LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT

  • LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE

  • LOCERR_FILE_ACCESS_DENIED

  • LOCERR_FILE_NAME_INVALID

  • LOCERR_FILE_CORRUPT

  • LOCERR_FILE_NOT_FOUND

  • LOCERR_FILE_FORMAT_UNSUPPORTED

  • LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE

  • LOCERR_FILE_TABLE_NOT_FOUND

  • LOCERR_USER_ACCESS_DENIED

  • LOCERR_USER_IMPERSONATION_FAILED

  • LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS

  • LOCERR_SERVER_OUT_OF_SESSION_CALS

  • LOCERR_SERVER_OUT_OF_USAGE_CALS

  • LOCERR_SERVER_OUT_OF_CALS

  • LOCERR_SERVER_OUT_OF_NAMED_CALS

  • LOCERR_SERVER_OFF_DUTY

  • LOCERR_SERVER_BUSY

  • LOCERR_SERVER_LICENSE_EXPIRED

  • LOCERR_SERVER_AJAX_DISABLED

  • LOCERR_SERVER_NO_TOKEN

  • LOCERR_HC_INVALID_OBJECT

  • LOCERR_HC_RESULT_TOO_LARGE

  • LOCERR_HC_INVALID_OBJECT_STATE

  • LOCERR_HC_MODAL_OBJECT_ERROR

  • LOCERR_CALC_INVALID_DEF

  • LOCERR_CALC_NOT_IN_LIB

  • LOCERR_CALC_HEAP_ERROR

  • LOCERR_CALC_TOO_LARGE

  • LOCERR_CALC_TIMEOUT

  • LOCERR_CALC_EVAL_CONDITION_FAILED

  • LOCERR_CALC_MIXED_LINKED_AGGREGATION

  • LOCERR_CALC_MISSING_LINKED

  • LOCERR_CALC_INVALID_COL_SORT

  • LOCERR_CALC_PAGES_TOO_LARGE

  • LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED

  • LOCERR_CALC_VALIDATION_STATE_INVALID

  • LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS

  • LOCERR_CALC_MISSING_LINKED_FIELD

  • LOCERR_CALC_NOT_CALCULATED

  • LOCERR_LAYOUT_EXTENDS_INVALID_ID

  • LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND

  • LOCERR_LAYOUT_LINKED_OBJECT_INVALID

  • LOCERR_PERSISTENCE_WRITE_FAILED

  • LOCERR_PERSISTENCE_READ_FAILED

  • LOCERR_PERSISTENCE_DELETE_FAILED

  • LOCERR_PERSISTENCE_NOT_FOUND

  • LOCERR_PERSISTENCE_UNSUPPORTED_VERSION

  • LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY

  • LOCERR_PERSISTENCE_MIGRATION_CANCELLED

  • LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED

  • LOCERR_PERSISTENCE_DISK_FULL

  • LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP

  • LOCERR_PERSISTENCE_MOVE_FAILED

  • LOCERR_PERSISTENCE_OBJECT_LOCKED

  • LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING

  • LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS

  • LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS

  • LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED

  • LOCERR_RELOAD_IN_PROGRESS

  • LOCERR_RELOAD_TABLE_X_NOT_FOUND

  • LOCERR_RELOAD_UNKNOWN_STATEMENT

  • LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN

  • LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN

  • LOCERR_RELOAD_FIELD_X_NOT_FOUND

  • LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND

  • LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND

  • LOCERR_RELOAD_NAME_ALREADY_TAKEN

  • LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF

  • LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF

  • LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED

  • LOCERR_RELOAD_OPEN_FILE_ERROR

  • LOCERR_RELOAD_AUTO_GENERATE_COUNT

  • LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB

  • LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR

  • LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND

  • LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID

  • LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE

  • LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE

  • LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS

  • LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS

  • LOCERR_RELOAD_NO_OPEN_DATABASE

  • LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY

  • LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE

  • LOCERR_RELOAD_ODBC_CONNECT_FAILED

  • LOCERR_RELOAD_OLEDB_CONNECT_FAILED

  • LOCERR_RELOAD_CUSTOM_CONNECT_FAILED

  • LOCERR_RELOAD_ODBC_READ_FAILED

  • LOCERR_RELOAD_OLEDB_READ_FAILED

  • LOCERR_RELOAD_CUSTOM_READ_FAILED

  • LOCERR_RELOAD_BINARY_LOAD_PROHIBITED

  • LOCERR_RELOAD_CONNECTOR_START_FAILED

  • LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING

  • LOCERR_RELOAD_CONNECTOR_REPLY_ERROR

  • LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR

  • LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR

  • LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS

  • LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE

  • LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD

  • LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT

  • LOCERR_RELOAD_EXIT_ERROR

  • LOCERR_PERSONAL_NEW_VERSION_AVAILABLE

  • LOCERR_PERSONAL_VERSION_EXPIRED

  • LOCERR_PERSONAL_SECTION_ACCESS_DETECTED

  • LOCERR_PERSONAL_APP_DELETION_FAILED

  • LOCERR_USER_AUTHENTICATION_FAILURE

  • LOCERR_EXPORT_OUT_OF_MEMORY

  • LOCERR_EXPORT_NO_DATA

  • LOCERR_SYNC_INVALID_OFFSET

  • LOCERR_SEARCH_TIMEOUT

  • LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL

  • LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW

  • LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT

  • LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED

  • LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED

  • LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED

  • LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED

  • LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED

  • LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED

  • LOCERR_SMART_LOAD_TABLE_NOT_FOUND

  • LOCERR_SMART_LOAD_TABLE_DUPLICATED

  • LOCERR_VARIABLE_NO_NAME

  • LOCERR_VARIABLE_DUPLICATE_NAME

  • LOCERR_VARIABLE_INCONSISTENCY

  • LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY

  • LOCERR_VARIABLE_CONSTRAINT_FAILED

  • LOCERR_MEDIA_LIBRARY_LIST_FAILED

  • LOCERR_MEDIA_LIBRARY_CONTENT_FAILED

  • LOCERR_MEDIA_BUNDLING_FAILED

  • LOCERR_MEDIA_UNBUNDLING_FAILED

  • LOCERR_MEDIA_LIBRARY_NOT_FOUND

  • LOCERR_FEATURE_DISABLED

  • LOCERR_LOAD_TOO_MANY_FIELDS

  • LOCERR_LOAD_TOO_MANY_TABLES

  • LOCERR_JSON_RPC_INVALID_REQUEST

  • LOCERR_JSON_RPC_METHOD_NOT_FOUND

  • LOCERR_JSON_RPC_INVALID_PARAMETERS

  • LOCERR_JSON_RPC_INTERNAL_ERROR

  • LOCERR_JSON_RPC_RESPONSE_TOO_LARGE

  • LOCERR_JSON_RPC_PARSE_ERROR

  • LOCERR_MQ_SOCKET_CONNECT_FAILURE

  • LOCERR_MQ_SOCKET_OPEN_FAILURE

  • LOCERR_MQ_PROTOCOL_NO_RESPONE

  • LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION

  • LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED

  • LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED

  • LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR

  • LOCERR_MQ_PROTOCOL_INVALID_STATUS

  • LOCERR_EXTENGINE_GRPC_STATUS_OK

  • LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED

  • LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN

  • LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT

  • LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED

  • LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND

  • LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS

  • LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED

  • LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED

  • LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION

  • LOCERR_EXTENGINE_GRPC_STATUS_ABORTED

  • LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE

  • LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED

  • LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL

  • LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE

  • LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS

  • LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED

  • LOCERR_LXW_INVALID_OBJ

  • LOCERR_LXW_INVALID_FILE

  • LOCERR_LXW_INVALID_SHEET

  • LOCERR_LXW_INVALID_EXPORT_RANGE

  • LOCERR_LXW_ERROR

  • LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED

  • LOCERR_LXW_ERROR_CREATING_XLSX_FILE

  • LOCERR_LXW_ERROR_CREATING_TMPFILE

  • LOCERR_LXW_ERROR_ZIP_FILE_OPERATION

  • LOCERR_LXW_ERROR_ZIP_FILE_ADD

  • LOCERR_LXW_ERROR_ZIP_CLOSE

  • LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED

  • LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED

  • LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED

  • LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND

  • LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE

  • LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED

  • LOCERR_BDI_STATUS_OK

  • LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED

  • LOCERR_TRENDLINE_INVALID_DEF

  • LOCERR_TRENDLINE_INVALID_MATH_ERROR

  • LOCERR_CURL_UNSUPPORTED_PROTOCOL

  • LOCERR_CURL_COULDNT_RESOLVE_PROXY

  • LOCERR_CURL_COULDNT_CONNECT

  • LOCERR_CURL_REMOTE_ACCESS_DENIED

  • LOCERR_CURL_FTP_ACCEPT_FAILED

  • LOCERR_CURL_FTP_ACCEPT_TIMEOUT

  • LOCERR_CURL_FTP_CANT_GET_HOST

  • LOCERR_CURL_PARTIAL_FILE

  • LOCERR_CURL_QUOTE_ERROR

  • LOCERR_CURL_WRITE_ERROR

  • LOCERR_CURL_UPLOAD_FAILED

  • LOCERR_CURL_OUT_OF_MEMORY

  • LOCERR_CURL_OPERATION_TIMEDOUT

  • LOCERR_CURL_FTP_COULDNT_USE_REST

  • LOCERR_CURL_HTTP_POST_ERROR

  • LOCERR_CURL_SSL_CONNECT_ERROR

  • LOCERR_CURL_FILE_COULDNT_READ_FILE

  • LOCERR_CURL_LDAP_CANNOT_BIND

  • LOCERR_CURL_LDAP_SEARCH_FAILED

  • LOCERR_CURL_TOO_MANY_REDIRECTS

  • LOCERR_CURL_PEER_FAILED_VERIFICATION

  • LOCERR_CURL_GOT_NOTHING

  • LOCERR_CURL_SSL_ENGINE_NOTFOUND

  • LOCERR_CURL_SSL_ENGINE_SETFAILED

  • LOCERR_CURL_SSL_CERTPROBLEM

  • LOCERR_CURL_SSL_CIPHER

  • LOCERR_CURL_SSL_CACERT

  • LOCERR_CURL_BAD_CONTENT_ENCODING

  • LOCERR_CURL_LDAP_INVALID_URL

  • LOCERR_CURL_USE_SSL_FAILED

  • LOCERR_CURL_SSL_ENGINE_INITFAILED

  • LOCERR_CURL_LOGIN_DENIED

  • LOCERR_CURL_TFTP_NOTFOUND

  • LOCERR_CURL_TFTP_ILLEGAL

  • LOCERR_CURL_SSH

  • LOCERR_SETEXPRESSION_TOO_LARGE

  • LOCERR_RELOAD_MERGE_LOAD_ERROR

  • LOCERR_WIN_FTP_DROPPED

  • LOCERR_WIN_FTP_NO_PASSIVE_MODE

  • LOCERR_WIN_HTTP_DOWNLEVEL_SERVER

  • LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE

  • LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION

  • LOCERR_WIN_INTERNET_FORCE_RETRY

  • LOCERR_WIN_INTERNET_CANNOT_CONNECT

  • LOCERR_WIN_INTERNET_CONNECTION_ABORTED

  • LOCERR_WIN_INTERNET_CONNECTION_RESET

  • LOCERR_WIN_INTERNET_DISCONNECTED

  • LOCERR_WIN_INTERNET_INCORRECT_FORMAT

  • LOCERR_WIN_INTERNET_INVALID_CA

  • LOCERR_WIN_INTERNET_INVALID_OPERATION

  • LOCERR_WIN_INTERNET_INVALID_URL

  • LOCERR_WIN_INTERNET_ITEM_NOT_FOUND

  • LOCERR_WIN_INTERNET_LOGIN_FAILURE

  • LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED

  • LOCERR_WIN_INTERNET_NEED_UI

  • LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID

  • LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID

  • LOCERR_WIN_INTERNET_SEC_CERT_ERRORS

  • LOCERR_WIN_INTERNET_SEC_INVALID_CERT

  • LOCERR_WIN_INTERNET_SERVER_UNREACHABLE

  • LOCERR_BM_RESULT_TOO_LARGE

schemas NxLocalizedWarningCode string

oneOf

  • LOCWARN_PERSONAL_RELOAD_REQUIRED

  • LOCWARN_PERSONAL_VERSION_EXPIRES_SOON

  • LOCWARN_EXPORT_DATA_TRUNCATED

  • LOCWARN_COULD_NOT_OPEN_ALL_OBJECTS

  • LOCWARN_SEARCH_INVALID_SEARCHFIELD_DETECTED

schemas NxMatchingFieldInfo object

Properties

  • qName string

    Name of the field.

  • qTags array of strings

    List of tags.

schemas NxMatchingFieldMode string

oneOf

  • MATCHINGFIELDMODE_MATCH_ALL

  • MATCHINGFIELDMODE_MATCH_ONE

schemas NxMeasure object

Either **qDef** or **qLibraryId** must be set, but not both. If both are set, the library measure's qDef and qLabel will be used.
If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.
A measure that is set in the library can be used by many objects.
expressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure. Attribute expressions do not affect the layout of an object. The sorting order is unchanged.

Properties

  • qLibraryId string

    Refers to a measure stored in the library.

  • qDef object
    Show qDef properties
    • qLabel string

      Name of the measure. An empty string is returned as a default value. This parameter is optional.

    • qDescription string

      Description of the measure. An empty string is returned as a default value. This parameter is optional.

    • qTags array of strings

      Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

    • qGrouping string

      Can be one of: "N""H""C"

    • qDef string

      Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qRelative boolean

      If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

    • qBrutalSum boolean

      If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

    • qAggrFunc string

      Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

    • qAccumulate integer
      • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

      format = int32

    • qReverseSort boolean

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

    • qActiveExpression integer

      Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

      format = int32

    • qExpressions array of strings

      Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

    • qLabelExpression string

      Label expression. This parameter is optional.
  • qSortBy object
    Show qSortBy properties
    • qSortByState integer

      Sorts the field values according to their logical state (selected, optional, alternative or excluded).

      format = int8

    • qSortByFrequency integer

      Sorts the field values by frequency (number of occurrences in the field).

      format = int8

    • qSortByNumeric integer

      Sorts the field values by numeric value.

      format = int8

    • qSortByAscii integer

      Sorts the field by alphabetical order.

      format = int8

    • qSortByLoadOrder integer

      Sorts the field values by the initial load order.

      format = int8

    • qSortByExpression integer

      Sorts the field by expression.

      format = int8

    • qExpression object
      Show qExpression properties
      • qv string

        Expression evaluated to dual.
    • qSortByGreyness integer

      format = int8

  • qAttributeExpressions array of objects

    List of attribute expressions.

    Show qAttributeExpressions properties
    • qExpression string

      Definition of the attribute expression. Example: "Max(OrderID)"

    • qLibraryId string

      Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

    • qAttribute boolean

      If set to true, this measure will not affect the number of rows in the cube.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qLabel string

      Label of the attribute expression.

    • qLabelExpression string

      Optional expression used for dynamic label.
  • qAttributeDimensions array of objects

    List of attribute dimensions.

    Show qAttributeDimensions properties
    • qDef string

      Expression or field name.

    • qLibraryId string

      LibraryId for dimension.

    • qSortBy object
      Show qSortBy properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qAttribute boolean

      If set to true, this attribute will not affect the number of rows in the cube.
  • qCalcCond object
    Show qCalcCond properties
    • qv string

      Expression evaluated to dual.
  • qCalcCondition object
    Show qCalcCondition properties
    • qCond object
      Show qCond properties
      • qv string

        Expression evaluated to dual.
    • qMsg object
      Show qMsg properties
      • qv string

        Expression evaluated to string.
  • qTrendLines array of objects
    Experimental

    Specifies trendlines for this measure.

    Show qTrendLines properties
    • qType string

      Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

    • qXColIx integer

      The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

      default = -1, format = int32, default = -1

    • qCalcR2 boolean

      Set to true to calulatate the R2 score

      default = false

    • qContinuousXAxis string

      Can be one of: "Never""Possible""Time"

    • qMultiDimMode string

      Can be one of: "Multi""Sum"

  • qMiniChartDef object
    Show qMiniChartDef properties
    • qDef string

      Expression or field name.

    • qLibraryId string

      LibraryId for dimension.

    • qSortBy object
      Show qSortBy properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qOtherTotalSpec object
      Show qOtherTotalSpec properties
      • qOtherMode string

        Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

      • qOtherCounted object
        Show qOtherCounted properties
        • qv string

          Expression evaluated to dual.
      • qOtherLimit object
        Show qOtherLimit properties
        • qv string

          Expression evaluated to dual.
      • qOtherLimitMode string

        Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

      • qSuppressOther boolean

        If set to true, the group Others is not displayed as a dimension value. The default value is false.

        default = false

      • qForceBadValueKeeping boolean

        This parameter is used when qOtherMode is set to:

        • OTHER_ABS_LIMITED
        • OTHER_REL_LIMITED
        • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

        and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

        default = true

      • qApplyEvenWhenPossiblyWrongResult boolean

        Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

        default = true

      • qGlobalOtherGrouping boolean

        This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

        default = false

      • qOtherCollapseInnerDimensions boolean

        If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

        default = false

      • qOtherSortMode string

        Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

      • qTotalMode string

        Can be one of: "TOTAL_OFF""TOTAL_EXPR"

      • qReferencedExpression object
        Show qReferencedExpression properties
        • qv string

          Expression evaluated to string.
    • qMaxNumberPoints integer

      default = -1, format = int32, default = -1

    • qAttributeExpressions array of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpression string

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryId string

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttribute boolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabel string

        Label of the attribute expression.

      • qLabelExpression string

        Optional expression used for dynamic label.
    • qNullSuppression boolean

      If set to true, no null values are returned.

schemas NxMeasureInfo object

Layout for NxInlineMeasureDef.

Properties

  • qFallbackTitle string

    Corresponds to the label of the measure. If the label is not defined then the measure name is used.

  • qApprMaxGlyphCount integer

    Length of the longest value in the field.

    format = int32

  • qCardinal integer

    Number of distinct field values.

    format = int32

  • qSortIndicator string

    Can be one of: "N""A""D"

  • qNumFormat object

    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:

    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.

    Show qNumFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qMin number

    Lowest value in the range.

    format = double

  • qMax number

    Highest value in the range.

    format = double

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.
  • qReverseSort boolean

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

  • 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 expression.

  • qAttrExprInfo array of objects

    List of attribute expressions.

    Show qAttrExprInfo properties
    • qMin number

      Minimum value.

      format = double

    • qMax number

      Maximum value.

      format = double

    • qFallbackTitle string
    • qMinText string

      String version of the minimum Value.

    • qMaxText string

      String version of the maximum Value.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • 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 expression.
  • qAttrDimInfo array of objects

    List of attribute dimensions.

    Show qAttrDimInfo properties
    • qCardinal integer

      Cardinality of the attribute expression.

      format = int32

    • qSize object
      Show qSize properties
      • qcx integer

        Number of pixels on the x axis.

        format = int32

      • qcy integer

        Number of pixels on the y axis.

        format = int32

    • qFallbackTitle string

      The title for the attribute dimension.

    • qLocked boolean

      The Locked value of the dimension.

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qIsCalculated boolean

      True if this is a calculated dimension.

      default = false

  • qCalcCondMsg string

    The message displayed if calculation condition is not fulfilled.

  • qLibraryId string

    Refers to a dimension stored in the library.

  • qTrendLines array of objects
    Experimental

    Calculated trendlines

    Show qTrendLines properties
    • qType string

      Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qCoeff array of numbers

      Coefficent c0..cN depending on the trendline type.

    • qR2 number

      R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

      format = double

    • qExpression string

      Trendline expression

    • qElemNo integer

      Inner Dim elem no

      format = int32

  • qMiniChart object
    Show qMiniChart properties
    • qYMin number

      format = double

    • qYMax number

      format = double

    • qXMin number

      format = double

    • qXMax number

      format = double

    • qAttrExprInfo array of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qFallbackTitle string
      • qMinText string

        String version of the minimum Value.

      • qMaxText string

        String version of the maximum Value.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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 expression.
    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.

schemas NxMeta object

Layout for NxMetaDef.

Properties

  • qName string

    Name. This property is optional.

schemas NxMetaDef object

Used to collect metadata.

Properties

Semantic type with an empty structure.

schemas NxMiniChart object

Properties

  • qYMin number

    format = double

  • qYMax number

    format = double

  • qXMin number

    format = double

  • qXMax number

    format = double

  • qAttrExprInfo array of objects

    List of attribute expressions.

    Show qAttrExprInfo properties
    • qMin number

      Minimum value.

      format = double

    • qMax number

      Maximum value.

      format = double

    • qFallbackTitle string
    • qMinText string

      String version of the minimum Value.

    • qMaxText string

      String version of the maximum Value.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • 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 expression.
  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.

schemas NxMiniChartCell object

Properties

  • qText string

    Some text.

  • qNum number

    A value. This parameter is optional.

    format = double

  • qElemNumber integer

    Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

    • -1: the cell is a Total cell. It shows a total.
    • -2: the cell is a Null cell.
    • -3: the cell belongs to the group Others .
    • -4: the cell is empty. Applies to pivot tables.

    format = int32

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

schemas NxMiniChartData object

Properties

  • qMatrix array of arrays

    Array of data.

    Show qMatrix properties
    • qText string

      Some text.

    • qNum number

      A value. This parameter is optional.

      format = double

    • qElemNumber integer

      Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

      • -1: the cell is a Total cell. It shows a total.
      • -2: the cell is a Null cell.
      • -3: the cell belongs to the group Others .
      • -4: the cell is empty. Applies to pivot tables.

      format = int32

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

  • qMin number

    format = double

  • qMax number

    format = double

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.

schemas NxMiniChartDef object

Properties

  • qDef string

    Expression or field name.

  • qLibraryId string

    LibraryId for dimension.

  • qSortBy object
    Show qSortBy properties
    • qSortByState integer

      Sorts the field values according to their logical state (selected, optional, alternative or excluded).

      format = int8

    • qSortByFrequency integer

      Sorts the field values by frequency (number of occurrences in the field).

      format = int8

    • qSortByNumeric integer

      Sorts the field values by numeric value.

      format = int8

    • qSortByAscii integer

      Sorts the field by alphabetical order.

      format = int8

    • qSortByLoadOrder integer

      Sorts the field values by the initial load order.

      format = int8

    • qSortByExpression integer

      Sorts the field by expression.

      format = int8

    • qExpression object
      Show qExpression properties
      • qv string

        Expression evaluated to dual.
    • qSortByGreyness integer

      format = int8

  • qOtherTotalSpec object
    Show qOtherTotalSpec properties
    • qOtherMode string

      Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

    • qOtherCounted object
      Show qOtherCounted properties
      • qv string

        Expression evaluated to dual.
    • qOtherLimit object
      Show qOtherLimit properties
      • qv string

        Expression evaluated to dual.
    • qOtherLimitMode string

      Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

    • qSuppressOther boolean

      If set to true, the group Others is not displayed as a dimension value. The default value is false.

      default = false

    • qForceBadValueKeeping boolean

      This parameter is used when qOtherMode is set to:

      • OTHER_ABS_LIMITED
      • OTHER_REL_LIMITED
      • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

      and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

      default = true

    • qApplyEvenWhenPossiblyWrongResult boolean

      Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

      default = true

    • qGlobalOtherGrouping boolean

      This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

      default = false

    • qOtherCollapseInnerDimensions boolean

      If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

      default = false

    • qOtherSortMode string

      Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

    • qTotalMode string

      Can be one of: "TOTAL_OFF""TOTAL_EXPR"

    • qReferencedExpression object
      Show qReferencedExpression properties
      • qv string

        Expression evaluated to string.
  • qMaxNumberPoints integer

    default = -1, format = int32, default = -1

  • qAttributeExpressions array of objects

    List of attribute expressions.

    Show qAttributeExpressions properties
    • qExpression string

      Definition of the attribute expression. Example: "Max(OrderID)"

    • qLibraryId string

      Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

    • qAttribute boolean

      If set to true, this measure will not affect the number of rows in the cube.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qLabel string

      Label of the attribute expression.

    • qLabelExpression string

      Optional expression used for dynamic label.
  • qNullSuppression boolean

    If set to true, no null values are returned.

schemas NxMiniChartRows object[]

Element properties

  • qText string

    Some text.

  • qNum number

    A value. This parameter is optional.

    format = double

  • qElemNumber integer

    Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

    • -1: the cell is a Total cell. It shows a total.
    • -2: the cell is a Null cell.
    • -3: the cell belongs to the group Others .
    • -4: the cell is empty. Applies to pivot tables.

    format = int32

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

schemas NxMultiRangeSelectInfo object

Properties

  • qRanges array of objects
    Show qRanges properties
    • qRange object
      Show qRange properties
      • qMin number

        Lowest value in the range

        format = double

      • qMax number

        Highest value in the range

        format = double

      • qMinInclEq boolean

        If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

      • qMaxInclEq boolean

        If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
    • qMeasureIx integer

      Number of the measure to select. Numbering starts from 0.

      format = int32

  • qColumnsToSelect array of integers

schemas NxOrigin string

oneOf

  • PROGRAM

  • SCRIPT

  • DATA_PRODUCT

schemas NxPage object

Properties

  • qLeft integer

    Position from the left. Corresponds to the first column.

    format = int32

  • qTop integer

    Position from the top. Corresponds to the first row.

    format = int32

  • qWidth integer

    Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

    format = int32

  • qHeight integer

    Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

    format = int32

schemas NxPageTreeLevel object

Properties

  • qLeft integer

    The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

    format = int32

  • qDepth integer

    Number of dimensions to include in the tree.

    default = -1, format = int32, default = -1

schemas NxPageTreeNode object

Defines an area of the tree to be fetched.

Properties

  • qArea object
    Show qArea properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qAllValues boolean

    When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.

schemas NxPatch object

Properties

  • qOp string

    Can be one of: "add""remove""replace"

  • qPath string

    Path to the property to add, remove or replace.

  • qValue string

    This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""

schemas NxPatchOperationType string

oneOf

  • add

    Add

  • remove

    Remove

  • replace

    Replace

schemas NxPatches object

Properties

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qPatches array of objects

    Array with patches.

    Show qPatches properties
    • qOp string

      Can be one of: "add""remove""replace"

    • qPath string

      Path to the property to add, remove or replace.

    • qValue string

      This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
  • qChildren array of objects

    Array with child objects and their patches.

    Show qChildren properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qPatches array of objects

      Array with patches.

      Show qPatches properties
      • qOp string

        Can be one of: "add""remove""replace"

      • qPath string

        Path to the property to add, remove or replace.

      • qValue string

        This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
    • qChildren array of undefineds

      Array with child objects and their patches.

schemas NxPivotDimensionCell object

Properties

  • qText string

    Some text.

  • qElemNo integer

    Rank number of the value. If set to -1, it means that the value is not an element number.

    format = int32

  • qValue number

    Value of the cell. Is set to NaN , if the value is not a number.

    format = double

  • qCanExpand boolean

    If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

  • qCanCollapse boolean

    If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

  • qType string

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qUp integer

    Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

    format = int32

  • qDown integer

    Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

    format = int32

  • qSubNodes array of objects

    Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

    Show qSubNodes properties
    • qText string

      Some text.

    • qElemNo integer

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpand boolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapse boolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qUp integer

      Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

      format = int32

    • qDown integer

      Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

      format = int32

    • qSubNodes array of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDims object
    Show qAttrDims properties
    • qValues array of objects

      List of values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNo integer

        Element number.

        format = int32

schemas NxPivotPage object

Properties

  • qLeft array of objects

    Information about the left dimension values of a pivot table.

    Show qLeft properties
    • qText string

      Some text.

    • qElemNo integer

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpand boolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapse boolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qUp integer

      Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

      format = int32

    • qDown integer

      Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

      format = int32

    • qSubNodes array of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

  • qTop array of objects

    Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.

    Show qTop properties
    • qText string

      Some text.

    • qElemNo integer

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpand boolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapse boolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qUp integer

      Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

      format = int32

    • qDown integer

      Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

      format = int32

    • qSubNodes array of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

  • qData array of arrays

    Array of data.

    Show qData properties
    • qLabel string

      Label of the cell. This parameter is optional.

    • qText string

      Some text related to the cell.

    • qNum number

      Value of the cell.

      format = double

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

  • qArea object
    Show qArea properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

schemas NxPivotValuePoint object

Properties

  • qLabel string

    Label of the cell. This parameter is optional.

  • qText string

    Some text related to the cell.

  • qNum number

    Value of the cell.

    format = double

  • qType string

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDims object
    Show qAttrDims properties
    • qValues array of objects

      List of values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNo integer

        Element number.

        format = int32

schemas NxRange object

Properties

  • qFrom integer

    Position in the expression of the first character of the field name.

    format = int32

  • qCount integer

    Number of characters in the field name.

    format = int32

schemas NxRangeSelectInfo object

Properties

  • qRange object
    Show qRange properties
    • qMin number

      Lowest value in the range

      format = double

    • qMax number

      Highest value in the range

      format = double

    • qMinInclEq boolean

      If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

    • qMaxInclEq boolean

      If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
  • qMeasureIx integer

    Number of the measure to select. Numbering starts from 0.

    format = int32

schemas NxSelectionCell object

Properties

  • qType string

    Can be one of: "D""T""L"

  • qCol integer

    Column index to select. Indexing starts from 0. If the cell's type is:

    • D, the index is based on the data matrix.
    • T, the index is based on the data matrix.
    • L, the index is based on the left dimensions indexes.

    format = int32

  • qRow integer

    Row index to select. Indexing starts from 0. If the cell's type is:

    • D, the index is based on the data matrix.
    • T, the index is based on the top dimensions indexes.
    • L, the index is based on the data matrix.

    format = int32

schemas NxSelectionCellType string

oneOf

  • D

    NX_CELL_DATA

  • T

    NX_CELL_TOP

  • L

    NX_CELL_LEFT

schemas NxSelectionInfo object

Properties

  • qInSelections boolean

    Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections Method.

  • qMadeSelections boolean

    Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see BeginSelections Method.

schemas NxSimpleDimValue object

Properties

  • qText string

    Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

  • qElemNo integer

    Element number.

    format = int32

schemas NxSimpleValue object

Properties

  • qText string

    Text related to the attribute expression value.

  • qNum number

    Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

    format = double

schemas NxSortIndicatorType string

oneOf

  • N

    NX_SORT_INDICATE_NONE

  • A

    NX_SORT_INDICATE_ASC

  • D

    NX_SORT_INDICATE_DESC

schemas NxStackPage object

Properties

  • qData array of objects

    Array of data.

    Show qData properties
    • qText string

      Some text.

    • qElemNo integer

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpand boolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapse boolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qMaxPos number

      Total of the positive values in the current group of cells.

      format = double

    • qMinNeg number

      Total of the negative values in the current group of cells.

      format = double

    • qUp integer

      Number of elements that are part of the previous tail.

      format = int32

    • qDown integer

      Number of elements that are part of the next tail.

      format = int32

    • qRow integer

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qSubNodes array of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

  • qArea object
    Show qArea properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

schemas NxStackedPivotCell object

Properties

  • qText string

    Some text.

  • qElemNo integer

    Rank number of the value. If set to -1, it means that the value is not an element number.

    format = int32

  • qValue number

    Value of the cell. Is set to NaN , if the value is not a number.

    format = double

  • qCanExpand boolean

    If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

  • qCanCollapse boolean

    If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

  • qType string

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qMaxPos number

    Total of the positive values in the current group of cells.

    format = double

  • qMinNeg number

    Total of the negative values in the current group of cells.

    format = double

  • qUp integer

    Number of elements that are part of the previous tail.

    format = int32

  • qDown integer

    Number of elements that are part of the next tail.

    format = int32

  • qRow integer

    Row index in the data matrix. The indexing starts from 0.

    format = int32

  • qSubNodes array of objects

    Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

    Show qSubNodes properties
    • qText string

      Some text.

    • qElemNo integer

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpand boolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapse boolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qMaxPos number

      Total of the positive values in the current group of cells.

      format = double

    • qMinNeg number

      Total of the negative values in the current group of cells.

      format = double

    • qUp integer

      Number of elements that are part of the previous tail.

      format = int32

    • qDown integer

      Number of elements that are part of the next tail.

      format = int32

    • qRow integer

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qSubNodes array of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDims object
    Show qAttrDims properties
    • qValues array of objects

      List of values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNo integer

        Element number.

        format = int32

schemas NxStateCounts object

Properties

  • qLocked integer

    Number of values in locked state.

    format = int32

  • qSelected integer

    Number of values in selected state.

    format = int32

  • qOption integer

    Number of values in optional state.

    format = int32

  • qDeselected integer

    Number of values in deselected state.

    format = int32

  • qAlternative integer

    Number of values in alternative state.

    format = int32

  • qExcluded integer

    Number of values in excluded state.

    format = int32

  • qSelectedExcluded integer

    Number of values in selected excluded state.

    format = int32

  • qLockedExcluded integer

    Number of values in locked excluded state.

    format = int32

schemas NxStreamListEntry object

Deprecated
This struct is deprecated (not recommended to use).

Properties

  • qName string

    Name of the stream.

  • qId string

    Identifier of the stream.

schemas NxTempBookmarkOptions object

Properties

  • qIncludeVariables boolean

    IncludeVariables If true all variables will be stored in the temporary bookmark

  • qIncludeAllPatches boolean

    IncludeAllPatches If true all patches will be stored in the temporary bookmark, if false ObjectIdsToPatch will determine what patches to include

schemas NxTickCell object

Properties

  • qText string

    Tick's label.

  • qStart number

    Start value.

    format = double

  • qEnd number

    End value.

    format = double

schemas NxTreeDataOption object

Specifies all the paging filters needed to define the tree to be fetched.

Properties

  • qMaxNbrOfNodes integer

    Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

    format = int32

  • qTreeNodes array of objects

    Defines areas of the tree to be fetched. Areas must be defined left to right.

    Show qTreeNodes properties
    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qAllValues boolean

      When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
  • qTreeLevels object
    Show qTreeLevels properties
    • qLeft integer

      The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

      format = int32

    • qDepth integer

      Number of dimensions to include in the tree.

      default = -1, format = int32, default = -1

schemas NxTreeDimensionDef object

Properties

  • qLibraryId string

    Refers to a dimension stored in the library.

  • qDef object
    Show qDef properties
    • qGrouping string

      Can be one of: "N""H""C"

    • qFieldDefs array of strings

      Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

    • qFieldLabels array of strings

      Array of field labels. This parameter is optional.

    • qSortCriterias array of objects

      Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

      Show qSortCriterias properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qNumberPresentations array of objects

      Defines the format of the value. This parameter is optional.

      Show qNumberPresentations properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qReverseSort boolean

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

    • qActiveField integer

      Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

      format = int32

    • qLabelExpression string

      Label expression. This parameter is optional.

    • qAlias string

      Alias of the dimension.
  • qValueExprs array of objects

    List of measures.

    Show qValueExprs properties
    • qLibraryId string

      Refers to a measure stored in the library.

    • qDef object
      Show qDef properties
      • qLabel string

        Name of the measure. An empty string is returned as a default value. This parameter is optional.

      • qDescription string

        Description of the measure. An empty string is returned as a default value. This parameter is optional.

      • qTags array of strings

        Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

      • qGrouping string

        Can be one of: "N""H""C"

      • qDef string

        Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRelative boolean

        If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

      • qBrutalSum boolean

        If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

      • qAggrFunc string

        Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

      • qAccumulate integer
        • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

        format = int32

      • qReverseSort boolean

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

      • qActiveExpression integer

        Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

        format = int32

      • qExpressions array of strings

        Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

      • qLabelExpression string

        Label expression. This parameter is optional.
    • qSortBy object
      Show qSortBy properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qAttributeExpressions array of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpression string

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryId string

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttribute boolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabel string

        Label of the attribute expression.

      • qLabelExpression string

        Optional expression used for dynamic label.
    • qAttributeDimensions array of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDef string

        Expression or field name.

      • qLibraryId string

        LibraryId for dimension.

      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qAttribute boolean

        If set to true, this attribute will not affect the number of rows in the cube.
    • qCalcCond object
      Show qCalcCond properties
      • qv string

        Expression evaluated to dual.
    • qCalcCondition object
      Show qCalcCondition properties
      • qCond object
        Show qCond properties
        • qv string

          Expression evaluated to dual.
      • qMsg object
        Show qMsg properties
        • qv string

          Expression evaluated to string.
    • qTrendLines array of objects
      Experimental

      Specifies trendlines for this measure.

      Show qTrendLines properties
      • qType string

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qXColIx integer

        The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

        default = -1, format = int32, default = -1

      • qCalcR2 boolean

        Set to true to calulatate the R2 score

        default = false

      • qContinuousXAxis string

        Can be one of: "Never""Possible""Time"

      • qMultiDimMode string

        Can be one of: "Multi""Sum"

    • qMiniChartDef object
      Show qMiniChartDef properties
      • qDef string

        Expression or field name.

      • qLibraryId string

        LibraryId for dimension.

      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qOtherTotalSpec object
        Show qOtherTotalSpec properties
        • qOtherMode string

          Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

        • qOtherCounted object
          Show qOtherCounted properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimit object
          Show qOtherLimit properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimitMode string

          Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

        • qSuppressOther boolean

          If set to true, the group Others is not displayed as a dimension value. The default value is false.

          default = false

        • qForceBadValueKeeping boolean

          This parameter is used when qOtherMode is set to:

          • OTHER_ABS_LIMITED
          • OTHER_REL_LIMITED
          • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

          and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

          default = true

        • qApplyEvenWhenPossiblyWrongResult boolean

          Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

          default = true

        • qGlobalOtherGrouping boolean

          This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

          default = false

        • qOtherCollapseInnerDimensions boolean

          If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

          default = false

        • qOtherSortMode string

          Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

        • qTotalMode string

          Can be one of: "TOTAL_OFF""TOTAL_EXPR"

        • qReferencedExpression object
          Show qReferencedExpression properties
          • qv string

            Expression evaluated to string.
      • qMaxNumberPoints integer

        default = -1, format = int32, default = -1

      • qAttributeExpressions array of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpression string

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryId string

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttribute boolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabel string

          Label of the attribute expression.

        • qLabelExpression string

          Optional expression used for dynamic label.
      • qNullSuppression boolean

        If set to true, no null values are returned.
  • qNullSuppression boolean

    If set to true, no null values are returned.

  • qOtherTotalSpec object
    Show qOtherTotalSpec properties
    • qOtherMode string

      Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

    • qOtherCounted object
      Show qOtherCounted properties
      • qv string

        Expression evaluated to dual.
    • qOtherLimit object
      Show qOtherLimit properties
      • qv string

        Expression evaluated to dual.
    • qOtherLimitMode string

      Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

    • qSuppressOther boolean

      If set to true, the group Others is not displayed as a dimension value. The default value is false.

      default = false

    • qForceBadValueKeeping boolean

      This parameter is used when qOtherMode is set to:

      • OTHER_ABS_LIMITED
      • OTHER_REL_LIMITED
      • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

      and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

      default = true

    • qApplyEvenWhenPossiblyWrongResult boolean

      Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

      default = true

    • qGlobalOtherGrouping boolean

      This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

      default = false

    • qOtherCollapseInnerDimensions boolean

      If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

      default = false

    • qOtherSortMode string

      Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

    • qTotalMode string

      Can be one of: "TOTAL_OFF""TOTAL_EXPR"

    • qReferencedExpression object
      Show qReferencedExpression properties
      • qv string

        Expression evaluated to string.
  • qShowAll boolean

    If set to true, all dimension values are shown.

  • qOtherLabel object
    Show qOtherLabel properties
    • qv string

      Expression evaluated to string.
  • qTotalLabel object
    Show qTotalLabel properties
    • qv string

      Expression evaluated to string.
  • qCalcCondition object
    Show qCalcCondition properties
    • qCond object
      Show qCond properties
      • qv string

        Expression evaluated to dual.
    • qMsg object
      Show qMsg properties
      • qv string

        Expression evaluated to string.
  • qAttributeExpressions array of objects

    List of attribute expressions.

    Show qAttributeExpressions properties
    • qExpression string

      Definition of the attribute expression. Example: "Max(OrderID)"

    • qLibraryId string

      Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

    • qAttribute boolean

      If set to true, this measure will not affect the number of rows in the cube.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qLabel string

      Label of the attribute expression.

    • qLabelExpression string

      Optional expression used for dynamic label.
  • qAttributeDimensions array of objects

    List of attribute dimensions.

    Show qAttributeDimensions properties
    • qDef string

      Expression or field name.

    • qLibraryId string

      LibraryId for dimension.

    • qSortBy object
      Show qSortBy properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qAttribute boolean

      If set to true, this attribute will not affect the number of rows in the cube.

schemas NxTreeDimensionInfo object

Properties

  • qFallbackTitle string

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

  • qApprMaxGlyphCount integer

    Length of the longest value in the field.

    format = int32

  • qCardinal integer Deprecated

    Number of distinct field values.

    format = int32

  • qLocked boolean

    Is set to true if the field is locked.

  • qSortIndicator string

    Can be one of: "N""A""D"

  • qGroupFallbackTitles array of strings

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

  • qGroupPos integer

    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.

    format = int32

  • qStateCounts object
    Show qStateCounts properties
    • qLocked integer

      Number of values in locked state.

      format = int32

    • qSelected integer

      Number of values in selected state.

      format = int32

    • qOption integer

      Number of values in optional state.

      format = int32

    • qDeselected integer

      Number of values in deselected state.

      format = int32

    • qAlternative integer

      Number of values in alternative state.

      format = int32

    • qExcluded integer

      Number of values in excluded state.

      format = int32

    • qSelectedExcluded integer

      Number of values in selected excluded state.

      format = int32

    • qLockedExcluded integer

      Number of values in locked excluded state.

      format = int32

  • qTags array of strings

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

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.
  • qDimensionType string

    Can be one of: "D""N""T"

  • qReverseSort boolean

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

  • qGrouping string

    Can be one of: "N""H""C"

  • qIsSemantic boolean

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

  • qNumFormat object

    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:

    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.

    Show qNumFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • 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.

  • qGroupFieldDefs array of strings

    Array of field names.

  • qMin number

    Minimum value.

    format = double

  • qMax number

    Maximum value.

    format = double

  • qContinuousAxes boolean

    Is continuous axis used.

  • qIsCyclic boolean

    Is a cyclic dimension used.

  • qDerivedField boolean

    Is derived field is used as a dimension.

  • qMeasureInfo array of objects

    A List of measures to be calculated on this TreeDimension.

    Show qMeasureInfo properties
    • qFallbackTitle string

      Corresponds to the label of the measure. If the label is not defined then the measure name is used.

    • qApprMaxGlyphCount integer

      Length of the longest value in the field.

      format = int32

    • qCardinal integer

      Number of distinct field values.

      format = int32

    • qSortIndicator string

      Can be one of: "N""A""D"

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qMin number

      Lowest value in the range.

      format = double

    • qMax number

      Highest value in the range.

      format = double

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qReverseSort boolean

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

    • 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 expression.

    • qAttrExprInfo array of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qFallbackTitle string
      • qMinText string

        String version of the minimum Value.

      • qMaxText string

        String version of the maximum Value.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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 expression.
    • qAttrDimInfo array of objects

      List of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinal integer

        Cardinality of the attribute expression.

        format = int32

      • qSize object
        Show qSize properties
        • qcx integer

          Number of pixels on the x axis.

          format = int32

        • qcy integer

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitle string

        The title for the attribute dimension.

      • qLocked boolean

        The Locked value of the dimension.

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsg string

      The message displayed if calculation condition is not fulfilled.

    • qLibraryId string

      Refers to a dimension stored in the library.

    • qTrendLines array of objects
      Experimental

      Calculated trendlines

      Show qTrendLines properties
      • qType string

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qCoeff array of numbers

        Coefficent c0..cN depending on the trendline type.

      • qR2 number

        R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

        format = double

      • qExpression string

        Trendline expression

      • qElemNo integer

        Inner Dim elem no

        format = int32

    • qMiniChart object
      Show qMiniChart properties
      • qYMin number

        format = double

      • qYMax number

        format = double

      • qXMin number

        format = double

      • qXMax number

        format = double

      • qAttrExprInfo array of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
  • qAttrExprInfo array of objects

    List of attribute expressions.

    Show qAttrExprInfo properties
    • qMin number

      Minimum value.

      format = double

    • qMax number

      Maximum value.

      format = double

    • qFallbackTitle string
    • qMinText string

      String version of the minimum Value.

    • qMaxText string

      String version of the maximum Value.

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • 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 expression.
  • qAttrDimInfo array of objects

    List of attribute dimensions.

    Show qAttrDimInfo properties
    • qCardinal integer

      Cardinality of the attribute expression.

      format = int32

    • qSize object
      Show qSize properties
      • qcx integer

        Number of pixels on the x axis.

        format = int32

      • qcy integer

        Number of pixels on the y axis.

        format = int32

    • qFallbackTitle string

      The title for the attribute dimension.

    • qLocked boolean

      The Locked value of the dimension.

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qIsCalculated boolean

      True if this is a calculated dimension.

      default = false

  • qCalcCondMsg string

    The message displayed if calculation condition is not fulfilled.

  • qIsCalculated boolean

    True if this is a calculated dimension.

    default = false

  • qIsOneAndOnlyOne boolean

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

  • qCardinalities object
    Show qCardinalities properties
    • qCardinal integer

      Number of distinct field values.

      format = int32

    • qHypercubeCardinal integer

      Number of distinct hypercube values.

      format = int32

    • qAllValuesCardinal integer

      Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

      default = -1, format = int32, default = -1

  • qLibraryId string

    Refers to a dimension stored in the library.

  • qEffectiveDimensionName string
    Experimental

    The expanded and stripped dimension name used internally in engine.

schemas NxTreeMultiRangeSelectInfo object

Properties

  • qRanges array of objects

    An array of Ranges.

    Show qRanges properties
    • qRange object
      Show qRange properties
      • qMin number

        Lowest value in the range

        format = double

      • qMax number

        Highest value in the range

        format = double

      • qMinInclEq boolean

        If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

      • qMaxInclEq boolean

        If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
    • qMeasureIx integer

      Number of the measure to select. Numbering starts from 0.

      format = int32

    • qDimensionIx integer

      Number of the dimension to select measure from. Numbering starts from 0.

      format = int32

schemas NxTreeNode object

Represents a dimension in the tree.

Properties

  • qText string

    The text version of the value, if available.

  • qValue number

    Value of the cell. Is set to NaN , if the value is not a number.

    format = double

  • qElemNo integer

    Element number.

    format = int32

  • qGroupPos integer

    The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

    format = int32

  • qGroupSize integer

    Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

    format = int32

  • qRow integer

    Row index in the data matrix. The indexing starts from 0.

    format = int32

  • qType string

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qValues array of objects

    The measures for this node.

    Show qValues properties
    • qText string

      The text version of the value, if available.

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

  • qNodes array of objects

    The children of this node in the fetched tree structure.

    Show qNodes properties
    • qText string

      The text version of the value, if available.

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qElemNo integer

      Element number.

      format = int32

    • qGroupPos integer

      The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

      format = int32

    • qGroupSize integer

      Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

      format = int32

    • qRow integer

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qValues array of objects

      The measures for this node.

      Show qValues properties
      • qText string

        The text version of the value, if available.

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qNodes array of undefineds

      The children of this node in the fetched tree structure.

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

    • qMaxPos array of numbers

      Total of the positive values in the current group of cells.

    • qMinNeg array of numbers

      Total of the negative values in the current group of cells.

    • qCanExpand boolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapse boolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qState string

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qTreePath array of integers

      The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.
  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDims object
    Show qAttrDims properties
    • qValues array of objects

      List of values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNo integer

        Element number.

        format = int32

  • qMaxPos array of numbers

    Total of the positive values in the current group of cells.

  • qMinNeg array of numbers

    Total of the negative values in the current group of cells.

  • qCanExpand boolean

    If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

  • qCanCollapse boolean

    If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

  • qState string

    Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

  • qTreePath array of integers

    The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.

schemas NxTreeRangeSelectInfo object

Properties

  • qRange object
    Show qRange properties
    • qMin number

      Lowest value in the range

      format = double

    • qMax number

      Highest value in the range

      format = double

    • qMinInclEq boolean

      If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

    • qMaxInclEq boolean

      If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
  • qMeasureIx integer

    Number of the measure to select. Numbering starts from 0.

    format = int32

  • qDimensionIx integer

    Number of the dimension to select measure from. Numbering starts from 0.

    format = int32

schemas NxTreeValue object

Represents a measure.

Properties

  • qText string

    The text version of the value, if available.

  • qValue number

    Value of the cell. Is set to NaN , if the value is not a number.

    format = double

  • qAttrExps object
    Show qAttrExps properties
    • qValues array of objects

      List of attribute expressions values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value.

      • qNum number

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDims object
    Show qAttrDims properties
    • qValues array of objects

      List of values.

      Show qValues properties
      • qText string

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNo integer

        Element number.

        format = int32

schemas NxTrendline object

Experimental

Information about the calculated trendline.

Properties

  • qType string

    Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.
  • qCoeff array of numbers

    Coefficent c0..cN depending on the trendline type.

  • qR2 number

    R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

    format = double

  • qExpression string

    Trendline expression

  • qElemNo integer

    Inner Dim elem no

    format = int32

schemas NxTrendlineDef object

Experimental

Trendline input definition

Properties

  • qType string

    Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

  • qXColIx integer

    The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

    default = -1, format = int32, default = -1

  • qCalcR2 boolean

    Set to true to calulatate the R2 score

    default = false

  • qContinuousXAxis string

    Can be one of: "Never""Possible""Time"

  • qMultiDimMode string

    Can be one of: "Multi""Sum"

schemas NxTrendlineMode string

oneOf

  • Multi

    TRENDLINE_MULTILINE

  • Sum

    TRENDLINE_SUM

schemas NxValidationError object

Properties

  • qErrorCode integer

    Error code. This parameter is always displayed in case of error.

    format = int32

  • qContext string

    Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

  • qExtendedMessage string

    Internal information from the server. This parameter is optional.

schemas NxVariableListItem object

Properties

  • qName string

    Name of the variable.

  • qDescription string

    Description of the variable.

  • qDefinition string

    Definition of the variable. It can be a value or an expression.

  • qIsConfig boolean

    If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false.

    default = false

  • qIsReserved boolean

    If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples:

    • ScriptError is a reserved variable, set by the engine.
    • DayNames is a reserved variable, set by the user.

    default = false

  • qMeta object

    Layout for NxMetaDef.

    Show qMeta properties
    • qName string

      Name. This property is optional.
  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qData object

    Contains dynamic JSON data specified by the client.

  • qIsScriptCreated boolean

    If set to true, it means that the variable was defined via script.

schemas NxVariableProperties object

Deprecated

Properties

  • qName string

    Name of the variable.

  • qNumberPresentation object

    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:

    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.

    Show qNumberPresentation properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qIncludeInBookmark boolean

    Set this property to true to update the variable when applying a bookmark. The value of a variable can affect the state of the selections. The default value is false.

    default = false

  • qUsePredefListedValues boolean

    The value of a variable can be an enumeration. Set this property to true to reflect the predefined values in an enumeration.

  • qPreDefinedList array of strings

    List of enumerations. This property is used if qUsePredefListedValues is set to true.

schemas NxViewPort object

Properties

  • qWidth integer

    Width of the canvas in pixels.

    format = int32

  • qHeight integer

    Height of the canvas in pixels.

    format = int32

  • qZoomLevel integer

    Zoom level.

    format = int32

schemas ObjectInterface object

Properties

  • qType string

    The native type of the object.

  • qHandle integer

    The handle used to connect to object.

    format = int32

  • qGenericType string

    The type of the object.

  • qGenericId string

    Object ID.

schemas OdbcDsn object

Properties

  • qName string

    Name of the ODBC connection.

  • qDescription string

    Description of the ODBC connection.

  • qBit32 boolean

    Is set to true if the version of ODBC is 32-bit. This parameter is optional. Default is false.

    default = false

  • qUserOnly boolean

    Is set to true if the connection is User DSN. The connection works only for a specific user. Default is false. This parameter is optional.

    default = false

schemas OleDbProvider object

Properties

  • qName string

    Name of the OLEDB provider.

  • qDescription string

    Description of the OLEDB provider.

  • qBit32 boolean

    Is set to true if the version of the OLEDB provider is 32-bit. Default is false. This parameter is optional.

    default = false

schemas OtherLimitMode string

oneOf

  • OTHER_GE_LIMIT

  • OTHER_LE_LIMIT

  • OTHER_GT_LIMIT

  • OTHER_LT_LIMIT

schemas OtherMode string

oneOf

  • OTHER_OFF

  • OTHER_COUNTED

  • OTHER_ABS_LIMITED

  • OTHER_ABS_ACC_TARGET

  • OTHER_REL_LIMITED

  • OTHER_REL_ACC_TARGET

schemas OtherSortMode string

oneOf

  • OTHER_SORT_DEFAULT

  • OTHER_SORT_DESCENDING

  • OTHER_SORT_ASCENDING

schemas OtherTotalSpecProp object

Properties

  • qOtherMode string

    Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

  • qOtherCounted object
    Show qOtherCounted properties
    • qv string

      Expression evaluated to dual.
  • qOtherLimit object
    Show qOtherLimit properties
    • qv string

      Expression evaluated to dual.
  • qOtherLimitMode string

    Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

  • qSuppressOther boolean

    If set to true, the group Others is not displayed as a dimension value. The default value is false.

    default = false

  • qForceBadValueKeeping boolean

    This parameter is used when qOtherMode is set to:

    • OTHER_ABS_LIMITED
    • OTHER_REL_LIMITED
    • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

    and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

    default = true

  • qApplyEvenWhenPossiblyWrongResult boolean

    Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

    default = true

  • qGlobalOtherGrouping boolean

    This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

    default = false

  • qOtherCollapseInnerDimensions boolean

    If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

    default = false

  • qOtherSortMode string

    Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

  • qTotalMode string

    Can be one of: "TOTAL_OFF""TOTAL_EXPR"

  • qReferencedExpression object
    Show qReferencedExpression properties
    • qv string

      Expression evaluated to string.

schemas Point object

Properties

  • qx integer

    x-coordinate in pixels. The origin is the top left of the screen.

    format = int32

  • qy integer

    y-coordinate in pixels. The origin is the top left of the screen.

    format = int32

schemas PositionMark object

Properties

  • qDimName string
  • qElemNo array of integers
  • qElemValues array of strings

schemas ProgressData object

Properties

  • qStarted boolean

    True if the request is started.

  • qFinished boolean

    True if the request is finished.

  • qCompleted integer

    This property is not used.

    format = int64

  • qTotal integer

    This property is not used.

    format = int64

  • qKB integer

    This property is not used.

    format = int32

  • qMillisecs integer

    Request duration in milliseconds.

    format = int32

  • qUserInteractionWanted boolean

    True when the engine pauses the script execution and waits for a user interaction.

  • qPersistentProgress string

    A progress message is persistent when it informs about the start or end of a statement. For example, it can inform about the total number of lines fetched from a data source or tell that the app was saved. All persistent progress messages between two GetProgress calls are summarized in this string. Contrarily to qPersistentProgressMessages, the content of the localized message string is displayed (not its message code).

  • qTransientProgress string

    A progress message is transient when it informs about the progress of an ongoing statement. For example, it can tell how many lines are currently fetched from a data source. All transient progress messages between two GetProgress calls are summarized in this string. Contrarily to qTransientProgressMessage, the content of the localized message string is displayed (not its message code).

  • qErrorData array of objects

    Information about the error messages that occur during the script execution.

    Show qErrorData properties
    • qErrorString string

      Detailed information about the error message.

    • qLineEnd string

      Line termination characters.

    • qLine string

      Script statement where the error occurs.

    • qErrorDataCode string

      Can be one of: "EDC_ERROR""EDC_WARNING""EDC_CIRCULAR_REFERENCE"

    • qMessage object
      Show qMessage properties
      • qMessageCode integer

        Code number to the corresponding localized message string.

        format = int32

      • qMessageParameters array of strings

        Parameters to be inserted in the localized message string.
  • qPersistentProgressMessages array of objects

    List of persistent progress messages.

    Show qPersistentProgressMessages properties
    • qMessageCode integer

      Code number to the corresponding localized message string.

      format = int32

    • qMessageParameters array of strings

      Parameters to be inserted in the localized message string.
  • qTransientProgressMessage object
    Show qTransientProgressMessage properties
    • qMessageCode integer

      Code number to the corresponding localized message string.

      format = int32

    • qMessageParameters array of strings

      Parameters to be inserted in the localized message string.

schemas ProgressMessage object

Properties

  • qMessageCode integer

    Code number to the corresponding localized message string.

    format = int32

  • qMessageParameters array of strings

    Parameters to be inserted in the localized message string.

schemas Range object

Properties

  • qMin number

    Lowest value in the range

    format = double

  • qMax number

    Highest value in the range

    format = double

  • qMinInclEq boolean

    If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

  • qMaxInclEq boolean

    If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.

schemas RangeSelectInfo object

Properties

  • qRangeLo number

    Lowest value in the range.

    default = -1e+300, format = double, default = -1e+300

  • qRangeHi number

    Highest value in the range.

    default = -1e+300, format = double, default = -1e+300

  • qMeasure string

    Label of the measure.

schemas Rect object

Properties

  • qLeft integer

    Position from the left. Corresponds to the first column.

    format = int32

  • qTop integer

    Position from the top. Corresponds to the first row.

    format = int32

  • qWidth integer

    Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

    format = int32

  • qHeight integer

    Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

    format = int32

schemas ReloadError object

Properties

  • qError string

    Type of error.

  • qDescription string

    Description of error.

  • qLine string

    Script line text where error occurred.

  • qLineNumber integer

    Script line number where error occurred (zero-based).

    format = int32

  • qCode integer

    Error code.

    format = int32

  • qTitle string

    Can be one of: "LOCERR_INTERNAL_ERROR""LOCERR_GENERIC_UNKNOWN""LOCERR_GENERIC_OK""LOCERR_GENERIC_NOT_SET""LOCERR_GENERIC_NOT_FOUND""LOCERR_GENERIC_ALREADY_EXISTS""LOCERR_GENERIC_INVALID_PATH""LOCERR_GENERIC_ACCESS_DENIED""LOCERR_GENERIC_OUT_OF_MEMORY""LOCERR_GENERIC_NOT_INITIALIZED""LOCERR_GENERIC_INVALID_PARAMETERS""LOCERR_GENERIC_EMPTY_PARAMETERS""LOCERR_GENERIC_INTERNAL_ERROR""LOCERR_GENERIC_CORRUPT_DATA""LOCERR_GENERIC_MEMORY_INCONSISTENCY""LOCERR_GENERIC_INVISIBLE_OWNER_ABORT""LOCERR_GENERIC_PROHIBIT_VALIDATE""LOCERR_GENERIC_ABORTED""LOCERR_GENERIC_CONNECTION_LOST""LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION""LOCERR_GENERIC_REST_CONNECTION_FAILURE""LOCERR_GENERIC_MEMORY_LIMIT_REACHED""LOCERR_GENERIC_NOT_IMPLEMENTED""LOCERR_GENERIC_ENGINE_TERMINATED""LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED""LOCERR_HTTP_400""LOCERR_HTTP_401""LOCERR_HTTP_402""LOCERR_HTTP_403""LOCERR_HTTP_404""LOCERR_HTTP_405""LOCERR_HTTP_406""LOCERR_HTTP_407""LOCERR_HTTP_408""LOCERR_HTTP_409""LOCERR_HTTP_410""LOCERR_HTTP_411""LOCERR_HTTP_412""LOCERR_HTTP_413""LOCERR_HTTP_414""LOCERR_HTTP_415""LOCERR_HTTP_416""LOCERR_HTTP_417""LOCERR_HTTP_422""LOCERR_HTTP_423""LOCERR_HTTP_429""LOCERR_HTTP_500""LOCERR_HTTP_501""LOCERR_HTTP_502""LOCERR_HTTP_503""LOCERR_HTTP_504""LOCERR_HTTP_505""LOCERR_HTTP_509""LOCERR_HTTP_COULD_NOT_RESOLVE_HOST""LOCERR_APP_ALREADY_EXISTS""LOCERR_APP_INVALID_NAME""LOCERR_APP_ALREADY_OPEN""LOCERR_APP_NOT_FOUND""LOCERR_APP_IMPORT_FAILED""LOCERR_APP_SAVE_FAILED""LOCERR_APP_CREATE_FAILED""LOCERR_APP_INVALID""LOCERR_APP_CONNECT_FAILED""LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE""LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE""LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION""LOCERR_APP_MIGRATION_FAILURE""LOCERR_APP_SCRIPT_MISSING""LOCERR_APP_EXPORT_FAILED""LOCERR_APP_SIZE_EXCEEDED""LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED""LOCERR_APP_NOT_OPEN""LOCERR_APP_EVENT_SOURCE_TIMEOUT""LOCERR_APP_SOFT_DELETED""LOCERR_CONNECTION_ALREADY_EXISTS""LOCERR_CONNECTION_NOT_FOUND""LOCERR_CONNECTION_FAILED_TO_LOAD""LOCERR_CONNECTION_FAILED_TO_IMPORT""LOCERR_CONNECTION_NAME_IS_INVALID""LOCERR_CONNECTION_MISSING_CREDENTIALS""LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT""LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE""LOCERR_FILE_ACCESS_DENIED""LOCERR_FILE_NAME_INVALID""LOCERR_FILE_CORRUPT""LOCERR_FILE_NOT_FOUND""LOCERR_FILE_FORMAT_UNSUPPORTED""LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE""LOCERR_FILE_TABLE_NOT_FOUND""LOCERR_USER_ACCESS_DENIED""LOCERR_USER_IMPERSONATION_FAILED""LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS""LOCERR_SERVER_OUT_OF_SESSION_CALS""LOCERR_SERVER_OUT_OF_USAGE_CALS""LOCERR_SERVER_OUT_OF_CALS""LOCERR_SERVER_OUT_OF_NAMED_CALS""LOCERR_SERVER_OFF_DUTY""LOCERR_SERVER_BUSY""LOCERR_SERVER_LICENSE_EXPIRED""LOCERR_SERVER_AJAX_DISABLED""LOCERR_SERVER_NO_TOKEN""LOCERR_HC_INVALID_OBJECT""LOCERR_HC_RESULT_TOO_LARGE""LOCERR_HC_INVALID_OBJECT_STATE""LOCERR_HC_MODAL_OBJECT_ERROR""LOCERR_CALC_INVALID_DEF""LOCERR_CALC_NOT_IN_LIB""LOCERR_CALC_HEAP_ERROR""LOCERR_CALC_TOO_LARGE""LOCERR_CALC_TIMEOUT""LOCERR_CALC_EVAL_CONDITION_FAILED""LOCERR_CALC_MIXED_LINKED_AGGREGATION""LOCERR_CALC_MISSING_LINKED""LOCERR_CALC_INVALID_COL_SORT""LOCERR_CALC_PAGES_TOO_LARGE""LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED""LOCERR_CALC_VALIDATION_STATE_INVALID""LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS""LOCERR_CALC_MISSING_LINKED_FIELD""LOCERR_CALC_NOT_CALCULATED""LOCERR_LAYOUT_EXTENDS_INVALID_ID""LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND""LOCERR_LAYOUT_LINKED_OBJECT_INVALID""LOCERR_PERSISTENCE_WRITE_FAILED""LOCERR_PERSISTENCE_READ_FAILED""LOCERR_PERSISTENCE_DELETE_FAILED""LOCERR_PERSISTENCE_NOT_FOUND""LOCERR_PERSISTENCE_UNSUPPORTED_VERSION""LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY""LOCERR_PERSISTENCE_MIGRATION_CANCELLED""LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED""LOCERR_PERSISTENCE_DISK_FULL""LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP""LOCERR_PERSISTENCE_MOVE_FAILED""LOCERR_PERSISTENCE_OBJECT_LOCKED""LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING""LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS""LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS""LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED""LOCERR_RELOAD_IN_PROGRESS""LOCERR_RELOAD_TABLE_X_NOT_FOUND""LOCERR_RELOAD_UNKNOWN_STATEMENT""LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_FIELD_X_NOT_FOUND""LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND""LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND""LOCERR_RELOAD_NAME_ALREADY_TAKEN""LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF""LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF""LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED""LOCERR_RELOAD_OPEN_FILE_ERROR""LOCERR_RELOAD_AUTO_GENERATE_COUNT""LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB""LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR""LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND""LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID""LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE""LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE""LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS""LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS""LOCERR_RELOAD_NO_OPEN_DATABASE""LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY""LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE""LOCERR_RELOAD_ODBC_CONNECT_FAILED""LOCERR_RELOAD_OLEDB_CONNECT_FAILED""LOCERR_RELOAD_CUSTOM_CONNECT_FAILED""LOCERR_RELOAD_ODBC_READ_FAILED""LOCERR_RELOAD_OLEDB_READ_FAILED""LOCERR_RELOAD_CUSTOM_READ_FAILED""LOCERR_RELOAD_BINARY_LOAD_PROHIBITED""LOCERR_RELOAD_CONNECTOR_START_FAILED""LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING""LOCERR_RELOAD_CONNECTOR_REPLY_ERROR""LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR""LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR""LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS""LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE""LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD""LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT""LOCERR_RELOAD_EXIT_ERROR""LOCERR_PERSONAL_NEW_VERSION_AVAILABLE""LOCERR_PERSONAL_VERSION_EXPIRED""LOCERR_PERSONAL_SECTION_ACCESS_DETECTED""LOCERR_PERSONAL_APP_DELETION_FAILED""LOCERR_USER_AUTHENTICATION_FAILURE""LOCERR_EXPORT_OUT_OF_MEMORY""LOCERR_EXPORT_NO_DATA""LOCERR_SYNC_INVALID_OFFSET""LOCERR_SEARCH_TIMEOUT""LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL""LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW""LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT""LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED""LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED""LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED""LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED""LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED""LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED""LOCERR_SMART_LOAD_TABLE_NOT_FOUND""LOCERR_SMART_LOAD_TABLE_DUPLICATED""LOCERR_VARIABLE_NO_NAME""LOCERR_VARIABLE_DUPLICATE_NAME""LOCERR_VARIABLE_INCONSISTENCY""LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY""LOCERR_VARIABLE_CONSTRAINT_FAILED""LOCERR_MEDIA_LIBRARY_LIST_FAILED""LOCERR_MEDIA_LIBRARY_CONTENT_FAILED""LOCERR_MEDIA_BUNDLING_FAILED""LOCERR_MEDIA_UNBUNDLING_FAILED""LOCERR_MEDIA_LIBRARY_NOT_FOUND""LOCERR_FEATURE_DISABLED""LOCERR_LOAD_TOO_MANY_FIELDS""LOCERR_LOAD_TOO_MANY_TABLES""LOCERR_JSON_RPC_INVALID_REQUEST""LOCERR_JSON_RPC_METHOD_NOT_FOUND""LOCERR_JSON_RPC_INVALID_PARAMETERS""LOCERR_JSON_RPC_INTERNAL_ERROR""LOCERR_JSON_RPC_RESPONSE_TOO_LARGE""LOCERR_JSON_RPC_PARSE_ERROR""LOCERR_MQ_SOCKET_CONNECT_FAILURE""LOCERR_MQ_SOCKET_OPEN_FAILURE""LOCERR_MQ_PROTOCOL_NO_RESPONE""LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION""LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED""LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED""LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR""LOCERR_MQ_PROTOCOL_INVALID_STATUS""LOCERR_EXTENGINE_GRPC_STATUS_OK""LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED""LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN""LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT""LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED""LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND""LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS""LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED""LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED""LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION""LOCERR_EXTENGINE_GRPC_STATUS_ABORTED""LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE""LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED""LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL""LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE""LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS""LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED""LOCERR_LXW_INVALID_OBJ""LOCERR_LXW_INVALID_FILE""LOCERR_LXW_INVALID_SHEET""LOCERR_LXW_INVALID_EXPORT_RANGE""LOCERR_LXW_ERROR""LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED""LOCERR_LXW_ERROR_CREATING_XLSX_FILE""LOCERR_LXW_ERROR_CREATING_TMPFILE""LOCERR_LXW_ERROR_ZIP_FILE_OPERATION""LOCERR_LXW_ERROR_ZIP_FILE_ADD""LOCERR_LXW_ERROR_ZIP_CLOSE""LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED""LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED""LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED""LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND""LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE""LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED""LOCERR_BDI_STATUS_OK""LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED""LOCERR_TRENDLINE_INVALID_DEF""LOCERR_TRENDLINE_INVALID_MATH_ERROR""LOCERR_CURL_UNSUPPORTED_PROTOCOL""LOCERR_CURL_COULDNT_RESOLVE_PROXY""LOCERR_CURL_COULDNT_CONNECT""LOCERR_CURL_REMOTE_ACCESS_DENIED""LOCERR_CURL_FTP_ACCEPT_FAILED""LOCERR_CURL_FTP_ACCEPT_TIMEOUT""LOCERR_CURL_FTP_CANT_GET_HOST""LOCERR_CURL_PARTIAL_FILE""LOCERR_CURL_QUOTE_ERROR""LOCERR_CURL_WRITE_ERROR""LOCERR_CURL_UPLOAD_FAILED""LOCERR_CURL_OUT_OF_MEMORY""LOCERR_CURL_OPERATION_TIMEDOUT""LOCERR_CURL_FTP_COULDNT_USE_REST""LOCERR_CURL_HTTP_POST_ERROR""LOCERR_CURL_SSL_CONNECT_ERROR""LOCERR_CURL_FILE_COULDNT_READ_FILE""LOCERR_CURL_LDAP_CANNOT_BIND""LOCERR_CURL_LDAP_SEARCH_FAILED""LOCERR_CURL_TOO_MANY_REDIRECTS""LOCERR_CURL_PEER_FAILED_VERIFICATION""LOCERR_CURL_GOT_NOTHING""LOCERR_CURL_SSL_ENGINE_NOTFOUND""LOCERR_CURL_SSL_ENGINE_SETFAILED""LOCERR_CURL_SSL_CERTPROBLEM""LOCERR_CURL_SSL_CIPHER""LOCERR_CURL_SSL_CACERT""LOCERR_CURL_BAD_CONTENT_ENCODING""LOCERR_CURL_LDAP_INVALID_URL""LOCERR_CURL_USE_SSL_FAILED""LOCERR_CURL_SSL_ENGINE_INITFAILED""LOCERR_CURL_LOGIN_DENIED""LOCERR_CURL_TFTP_NOTFOUND""LOCERR_CURL_TFTP_ILLEGAL""LOCERR_CURL_SSH""LOCERR_SETEXPRESSION_TOO_LARGE""LOCERR_RELOAD_MERGE_LOAD_ERROR""LOCERR_WIN_FTP_DROPPED""LOCERR_WIN_FTP_NO_PASSIVE_MODE""LOCERR_WIN_HTTP_DOWNLEVEL_SERVER""LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE""LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION""LOCERR_WIN_INTERNET_FORCE_RETRY""LOCERR_WIN_INTERNET_CANNOT_CONNECT""LOCERR_WIN_INTERNET_CONNECTION_ABORTED""LOCERR_WIN_INTERNET_CONNECTION_RESET""LOCERR_WIN_INTERNET_DISCONNECTED""LOCERR_WIN_INTERNET_INCORRECT_FORMAT""LOCERR_WIN_INTERNET_INVALID_CA""LOCERR_WIN_INTERNET_INVALID_OPERATION""LOCERR_WIN_INTERNET_INVALID_URL""LOCERR_WIN_INTERNET_ITEM_NOT_FOUND""LOCERR_WIN_INTERNET_LOGIN_FAILURE""LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED""LOCERR_WIN_INTERNET_NEED_UI""LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID""LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID""LOCERR_WIN_INTERNET_SEC_CERT_ERRORS""LOCERR_WIN_INTERNET_SEC_INVALID_CERT""LOCERR_WIN_INTERNET_SERVER_UNREACHABLE""LOCERR_BM_RESULT_TOO_LARGE"

schemas SampleResult object

Properties

  • qFieldOrColumn object
    Show qFieldOrColumn properties
    • qFieldName string

      Name of the field or column to be matched.

    • qTableName string

      Name of the table to be matched on. This parameter is optional. If TableName is set, FieldName represent the Table column with that name. If TableName is not set, FieldName represents the the field with that name.
  • qValues array of objects

    Matched values part of the sample.

    Show qValues properties
    • qText string

      Text related to the field value. This parameter is optional.

    • qIsNumeric boolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumber number

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

schemas ScriptSyntaxError object

Properties

  • qErrLen integer

    Length of the word where the error is located.

    default = 0, format = int32, default = 0

  • qTabIx integer

    Number of the faulty section.

    default = 0, format = int32, default = 0

  • qLineInTab integer

    Line number in the section where the error is located.

    default = 0, format = int32, default = 0

  • qColInLine integer

    Position of the erroneous text from the beginning of the line.

    default = 0, format = int32, default = 0

  • qTextPos integer

    Position of the erroneous text from the beginning of the script.

    default = 0, format = int32, default = 0

  • qSecondaryFailure boolean

    The default value is false.

schemas ScrollPosition object

Properties

  • qUsePosition boolean
  • qPos object
    Show qPos properties
    • qx integer

      x-coordinate in pixels. The origin is the top left of the screen.

      format = int32

    • qy integer

      y-coordinate in pixels. The origin is the top left of the screen.

      format = int32

schemas SearchAssociationResult object

Deprecated

Properties

  • qFieldNames array of strings

    List of the fields that contains search associations.

  • qSearchTerms array of strings

    List of the search terms.

  • qFieldDictionaries array of objects Deprecated

    Information about the fields containing search hits.

    Show qFieldDictionaries properties
    • qField integer

      Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.

      format = int32

    • qResult array of objects Deprecated

      List of the matching values. The maximum number of values in this list is set by qMaxNbrFieldMatches .

      Show qResult properties
      • qText string

        Text of the associated value.

      • qElemNumber integer

        Element number of the associated value.

        format = int32

      • qRanges array of objects

        List of ranges. For example, if the user searches the term read and the associative value is Reading , then the corresponding range would be Read in Reading .

        Show qRanges properties
        • qCharPos integer

          Starting position of the match in the search result, starting from 0.

          format = int32

        • qCharCount integer

          Length of the match in the search result.

          format = int32

        • qTerm integer

          Position of the term in the list of search terms, starting from 0.

          format = int32

  • qSearchTermsMatched array of arrays Deprecated

    List of search results. The maximum number of search results in this list is set by qPage/qCount .

    Show qSearchTermsMatched properties
    • qId integer

      Index of the search result, starting from 0.

      format = int32

    • qFieldMatches array of objects Deprecated

      Information about the search matches.

      Show qFieldMatches properties
      • qField integer

        Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.

        format = int32

      • qValues array of integers

        Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .

      • qTerms array of integers

        Positions of the search terms, starting from 0.

      • qNoOfMatches integer

        Number of search hits in the field. The number of values in qValues and the value of qNoOfMatches are equal if qMaxNbrFieldMatches is -1.

        format = int32

  • qTotalSearchResults integer

    Total number of search results. This number is not limited by qPage/qCount .

    format = int32

schemas SearchAttribute object

Properties

  • qKey string

    String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

  • qValue string

    String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title.

schemas SearchCharRange object

Properties

  • qCharPos integer

    Starting position of the match in the search result, starting from 0.

    format = int32

  • qCharCount integer

    Length of the match in the search result.

    format = int32

  • qTerm integer

    Position of the term in the list of search terms, starting from 0.

    format = int32

schemas SearchCombinationOptions object

Properties

  • qSearchFields array of strings

    List of the search fields. If empty, the search is performed in all fields of the app.

  • qContext string

    Can be one of: "Cleared""LockedFieldsOnly""CurrentSelections"

  • qCharEncoding string

    Can be one of: "Utf8""Utf16"

  • qAttributes array of strings

    Optional.

    • For SearchSuggest method, this array is empty.
    • For SearchObjects method, this array is empty or contain qProperty .
    • For SearchResults method, this array is empty, or contains qNum and/or qElemNum . It allows the user to request details in the outputted SearchGroupItemMatch . For more information, see SearchGroupItemMatch.

schemas SearchContextType string

oneOf

  • Cleared

    CONTEXT_CLEARED

  • LockedFieldsOnly

    CONTEXT_LOCKED_FIELDS_ONLY

  • CurrentSelections

    CONTEXT_CURRENT_SELECTIONS

schemas SearchFieldDictionary object

Deprecated

Properties

  • qField integer

    Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.

    format = int32

  • qResult array of objects Deprecated

    List of the matching values. The maximum number of values in this list is set by qMaxNbrFieldMatches .

    Show qResult properties
    • qText string

      Text of the associated value.

    • qElemNumber integer

      Element number of the associated value.

      format = int32

    • qRanges array of objects

      List of ranges. For example, if the user searches the term read and the associative value is Reading , then the corresponding range would be Read in Reading .

      Show qRanges properties
      • qCharPos integer

        Starting position of the match in the search result, starting from 0.

        format = int32

      • qCharCount integer

        Length of the match in the search result.

        format = int32

      • qTerm integer

        Position of the term in the list of search terms, starting from 0.

        format = int32

schemas SearchFieldMatch object

Deprecated

Properties

  • qField integer

    Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.

    format = int32

  • qValues array of integers

    Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .

  • qTerms array of integers

    Positions of the search terms, starting from 0.

  • qNoOfMatches integer

    Number of search hits in the field. The number of values in qValues and the value of qNoOfMatches are equal if qMaxNbrFieldMatches is -1.

    format = int32

schemas SearchFieldMatchType string

oneOf

  • FieldMatchNone

    FM_NONE

  • FieldMatchSubString

    FM_SUBSTRING

  • FieldMatchWord

    FM_WORD

  • FieldMatchExact

    FM_EXACT

  • FieldMatchLast

    FM_LAST

schemas SearchFieldMatchesItem object

Experimental

Properties

  • qText string
  • qElemNo integer

    format = int32

  • qSearchTermsMatched array of integers

schemas SearchFieldSelectionMode string

oneOf

  • OneAndOnlyOne

    ONE_AND_ONLY_ONE

schemas SearchFieldValueItem object

Experimental

Properties

  • qFieldName string

    Field name of matches.

  • qValues array of objects
    Experimental

    List of search matches.

    Show qValues properties
    • qText string
    • qElemNo integer

      format = int32

    • qSearchTermsMatched array of integers

schemas SearchGroup object

Properties

  • qId integer

    Identifier of the search group.

    format = int32

  • qGroupType string

    Can be one of: "DatasetType""GenericObjectsType"

  • qSearchTermsMatched array of integers

    Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .

  • qTotalNumberOfItems integer

    Total number of distinct items in the search group.

    format = int32

  • qItems array of objects

    List of items in the search group. The group items are numbered from the value of SearchGroupOptions.qOffset to the value of SearchGroupOptions.qOffset + SearchGroupOptions.qCount

    Show qItems properties
    • qItemType string

      Can be one of: "Field""GenericObject"

    • qTotalNumberOfMatches integer

      Total number of distinct matches in the search group item.

      format = int32

    • qIdentifier string

      Identifier of the item. It corresponds to:

      • The name of the field, if the type of the search group is data set.
      • The id of the generic object if the type of the search group is generic object.
    • qItemMatches array of objects

      List of matches in the search group item. The group item matches are numbered from the value of SearchGroupItemOptions.qOffset to the value of SearchGroupItemOptions.qOffset + SearchGroupItemOptions.qCount .

      Show qItemMatches properties
      • qText string

        Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value.

      • qFieldSelectionMode string

        Can be one of: "OneAndOnlyOne"

      • qRanges array of objects

        List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.

        Show qRanges properties
        • qCharPos integer

          Starting position of the match in the search result, starting from 0.

          format = int32

        • qCharCount integer

          Length of the match in the search result.

          format = int32

        • qTerm integer

          Position of the term in the list of search terms, starting from 0.

          format = int32

      • qAttributes array of objects

        Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty. For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains [“qProperty”, "qMetaDef/title”] if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” . For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains ["qNum", N] where N is the numeric value of the element or NaN if the value is not numeric. For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains ["qElemNum", N] where N is the value index of the element.

        Show qAttributes properties
        • qKey string

          String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

        • qValue string

          String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title.
    • qSearchTermsMatched array of integers

      Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .

    • qMatchType string

      Can be one of: "FieldMatchNone""FieldMatchSubString""FieldMatchWord""FieldMatchExact""FieldMatchLast"

schemas SearchGroupItem object

Properties

  • qItemType string

    Can be one of: "Field""GenericObject"

  • qTotalNumberOfMatches integer

    Total number of distinct matches in the search group item.

    format = int32

  • qIdentifier string

    Identifier of the item. It corresponds to:

    • The name of the field, if the type of the search group is data set.
    • The id of the generic object if the type of the search group is generic object.
  • qItemMatches array of objects

    List of matches in the search group item. The group item matches are numbered from the value of SearchGroupItemOptions.qOffset to the value of SearchGroupItemOptions.qOffset + SearchGroupItemOptions.qCount .

    Show qItemMatches properties
    • qText string

      Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value.

    • qFieldSelectionMode string

      Can be one of: "OneAndOnlyOne"

    • qRanges array of objects

      List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.

      Show qRanges properties
      • qCharPos integer

        Starting position of the match in the search result, starting from 0.

        format = int32

      • qCharCount integer

        Length of the match in the search result.

        format = int32

      • qTerm integer

        Position of the term in the list of search terms, starting from 0.

        format = int32

    • qAttributes array of objects

      Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty. For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains [“qProperty”, "qMetaDef/title”] if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” . For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains ["qNum", N] where N is the numeric value of the element or NaN if the value is not numeric. For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains ["qElemNum", N] where N is the value index of the element.

      Show qAttributes properties
      • qKey string

        String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

      • qValue string

        String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title.
  • qSearchTermsMatched array of integers

    Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .

  • qMatchType string

    Can be one of: "FieldMatchNone""FieldMatchSubString""FieldMatchWord""FieldMatchExact""FieldMatchLast"

schemas SearchGroupItemMatch object

Properties

  • qText string

    Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value.

  • qFieldSelectionMode string

    Can be one of: "OneAndOnlyOne"

  • qRanges array of objects

    List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.

    Show qRanges properties
    • qCharPos integer

      Starting position of the match in the search result, starting from 0.

      format = int32

    • qCharCount integer

      Length of the match in the search result.

      format = int32

    • qTerm integer

      Position of the term in the list of search terms, starting from 0.

      format = int32

  • qAttributes array of objects

    Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty. For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains [“qProperty”, "qMetaDef/title”] if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” . For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains ["qNum", N] where N is the numeric value of the element or NaN if the value is not numeric. For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains ["qElemNum", N] where N is the value index of the element.

    Show qAttributes properties
    • qKey string

      String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

    • qValue string

      String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title.

schemas SearchGroupItemOptions object

Properties

  • qGroupItemType string

    Can be one of: "Field""GenericObject"

  • qOffset integer

    Position starting from 0. The default value is 0.

    default = 0, format = int32, default = 0

  • qCount integer

    Maximum number of matches per item (in qItemMatches[ ] ). The default value is -1: all values are returned.

    default = -1, format = int32, default = -1

schemas SearchGroupItemType string

oneOf

  • Field

    FIELD

  • GenericObject

    GENERIC_OBJECT

schemas SearchGroupOptions object

Properties

  • qGroupType string

    Can be one of: "DatasetType""GenericObjectsType"

  • qOffset integer

    Position starting from 0. The default value is 0.

    default = 0, format = int32, default = 0

  • qCount integer

    Maximum number of items per group (in qItems[ ] ). The default value is -1; all values are returned.

    default = -1, format = int32, default = -1

schemas SearchGroupType string

oneOf

  • DatasetType

    DATASET_GROUP

  • GenericObjectsType

    GENERIC_OBJECTS_GROUP

schemas SearchMatchCombination object

Deprecated

Properties

  • qId integer

    Index of the search result, starting from 0.

    format = int32

  • qFieldMatches array of objects Deprecated

    Information about the search matches.

    Show qFieldMatches properties
    • qField integer

      Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.

      format = int32

    • qValues array of integers

      Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .

    • qTerms array of integers

      Positions of the search terms, starting from 0.

    • qNoOfMatches integer

      Number of search hits in the field. The number of values in qValues and the value of qNoOfMatches are equal if qMaxNbrFieldMatches is -1.

      format = int32

schemas SearchMatchCombinations object[]

Deprecated

Element properties

  • qId integer

    Index of the search result, starting from 0.

    format = int32

  • qFieldMatches array of objects Deprecated

    Information about the search matches.

    Show qFieldMatches properties
    • qField integer

      Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.

      format = int32

    • qValues array of integers

      Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .

    • qTerms array of integers

      Positions of the search terms, starting from 0.

    • qNoOfMatches integer

      Number of search hits in the field. The number of values in qValues and the value of qNoOfMatches are equal if qMaxNbrFieldMatches is -1.

      format = int32

schemas SearchObjectOptions object

Properties

  • qAttributes array of strings

    This array is either empty or contains qProperty .

  • qCharEncoding string

    Can be one of: "Utf8""Utf16"

schemas SearchPage object

Properties

  • qOffset integer

    Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0.

    format = int32

  • qCount integer

    Number of search groups to return (in qSearchGroupArray ).

    format = int32

  • qMaxNbrFieldMatches integer

    Maximum number of matching values to return per search result. The default value is -1; all values are returned. This property is to be used with the SearchAssociations method.

    default = -1, format = int32, default = -1

  • qGroupOptions array of objects

    Options of the search groups. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method.

    Show qGroupOptions properties
    • qGroupType string

      Can be one of: "DatasetType""GenericObjectsType"

    • qOffset integer

      Position starting from 0. The default value is 0.

      default = 0, format = int32, default = 0

    • qCount integer

      Maximum number of items per group (in qItems[ ] ). The default value is -1; all values are returned.

      default = -1, format = int32, default = -1

  • qGroupItemOptions array of objects

    Options of the search group items. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method.

    Show qGroupItemOptions properties
    • qGroupItemType string

      Can be one of: "Field""GenericObject"

    • qOffset integer

      Position starting from 0. The default value is 0.

      default = 0, format = int32, default = 0

    • qCount integer

      Maximum number of matches per item (in qItemMatches[ ] ). The default value is -1: all values are returned.

      default = -1, format = int32, default = -1

schemas SearchResult object

Properties

  • qSearchTerms array of strings

    List of the search terms.

  • qTotalNumberOfGroups integer

    Total number of groups.

    format = int32

  • qSearchGroupArray array of objects

    List of search groups. The groups are numbered from the value of SearchPage.qOffset to the value of SearchPage.qOffset + SearchPage.qCount .

    Show qSearchGroupArray properties
    • qId integer

      Identifier of the search group.

      format = int32

    • qGroupType string

      Can be one of: "DatasetType""GenericObjectsType"

    • qSearchTermsMatched array of integers

      Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .

    • qTotalNumberOfItems integer

      Total number of distinct items in the search group.

      format = int32

    • qItems array of objects

      List of items in the search group. The group items are numbered from the value of SearchGroupOptions.qOffset to the value of SearchGroupOptions.qOffset + SearchGroupOptions.qCount

      Show qItems properties
      • qItemType string

        Can be one of: "Field""GenericObject"

      • qTotalNumberOfMatches integer

        Total number of distinct matches in the search group item.

        format = int32

      • qIdentifier string

        Identifier of the item. It corresponds to:

        • The name of the field, if the type of the search group is data set.
        • The id of the generic object if the type of the search group is generic object.
      • qItemMatches array of objects

        List of matches in the search group item. The group item matches are numbered from the value of SearchGroupItemOptions.qOffset to the value of SearchGroupItemOptions.qOffset + SearchGroupItemOptions.qCount .

        Show qItemMatches properties
        • qText string

          Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value.

        • qFieldSelectionMode string

          Can be one of: "OneAndOnlyOne"

        • qRanges array of objects

          List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.

          Show qRanges properties
          • qCharPos integer

            Starting position of the match in the search result, starting from 0.

            format = int32

          • qCharCount integer

            Length of the match in the search result.

            format = int32

          • qTerm integer

            Position of the term in the list of search terms, starting from 0.

            format = int32

        • qAttributes array of objects

          Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty. For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains [“qProperty”, "qMetaDef/title”] if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” . For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains ["qNum", N] where N is the numeric value of the element or NaN if the value is not numeric. For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains ["qElemNum", N] where N is the value index of the element.

          Show qAttributes properties
          • qKey string

            String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

          • qValue string

            String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title.
      • qSearchTermsMatched array of integers

        Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .

      • qMatchType string

        Can be one of: "FieldMatchNone""FieldMatchSubString""FieldMatchWord""FieldMatchExact""FieldMatchLast"

schemas SearchSuggestItem object

Properties

  • qValue string

    Value of the suggestion.

  • qTerm integer

    Index of the suggestion value. The indexing starts from 0 and from the left.

    format = int32

schemas SearchSuggestionResult object

Properties

  • qSuggestions array of objects

    List of suggestions.

    Show qSuggestions properties
    • qValue string

      Value of the suggestion.

    • qTerm integer

      Index of the suggestion value. The indexing starts from 0 and from the left.

      format = int32

  • qFieldNames array of strings

    List of field names that contain search hits.

schemas SearchTermResult object

Deprecated

Properties

  • qText string

    Text of the associated value.

  • qElemNumber integer

    Element number of the associated value.

    format = int32

  • qRanges array of objects

    List of ranges. For example, if the user searches the term read and the associative value is Reading , then the corresponding range would be Read in Reading .

    Show qRanges properties
    • qCharPos integer

      Starting position of the match in the search result, starting from 0.

      format = int32

    • qCharCount integer

      Length of the match in the search result.

      format = int32

    • qTerm integer

      Position of the term in the list of search terms, starting from 0.

      format = int32

schemas SearchValueOptions object

Experimental

Properties

  • qSearchFields array of strings

    List of the search fields. If empty, the search is performed in all fields of the app.

schemas SearchValuePage object

Experimental

Properties

  • qOffset integer

    Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0.

    format = int32

  • qCount integer

    Number of search fields to return

    format = int32

  • qMaxNbrFieldMatches integer

    Maximum number of matching values to return per search result.

    default = -1, format = int32, default = -1

schemas SearchValueResult object

Experimental

Properties

  • qSearchTerms array of strings

    List of the search terms.

  • qFieldMatches array of objects
    Experimental

    List of search groups. The groups are numbered from the value of SearchPage.qOffset to the value of SearchPage.qOffset + SearchPage.qCount .

    Show qFieldMatches properties
    • qFieldName string

      Field name of matches.

    • qValues array of objects
      Experimental

      List of search matches.

      Show qValues properties
      • qText string
      • qElemNo integer

        format = int32

      • qSearchTermsMatched array of integers

schemas SelectInfo object

Properties

  • qTextSearch string

    Text search string. Everything that matches the text is selected. This parameter is optional.

  • qRangeLo number

    Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

    default = -1e+300, format = double, default = -1e+300

  • qRangeHi number

    Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

    default = -1e+300, format = double, default = -1e+300

  • qNumberFormat object

    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:

    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.

    Show qNumberFormat properties
    • qType string

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDec integer

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThou integer

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmt string

      Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

    • qDec string

      Defines the decimal separator. Example: .

    • qThou string

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qRangeInfo array of objects

    This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

    Show qRangeInfo properties
    • qRangeLo number

      Lowest value in the range.

      default = -1e+300, format = double, default = -1e+300

    • qRangeHi number

      Highest value in the range.

      default = -1e+300, format = double, default = -1e+300

    • qMeasure string

      Label of the measure.
  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

    default = false

  • qContinuousRangeInfo array of objects

    List of information about ranges for selections.

    Show qContinuousRangeInfo properties
    • qMin number

      Lowest value in the range

      format = double

    • qMax number

      Highest value in the range

      format = double

    • qMinInclEq boolean

      If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

    • qMaxInclEq boolean

      If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
  • qSelectFieldSearch boolean

    This parameter is true if the TextSearch is a result of a Select Field operation.

    default = false

schemas SelectionObject object

Indicates which selections are currently applied. It gives the current selections. Is the layout for SelectionObjectDef.

Properties

  • qBackCount integer

    Number of steps back.

    format = int32

  • qForwardCount integer

    Number of steps forward.

    format = int32

  • qSelections array of objects

    Lists the fields that are selected.

    Show qSelections properties
    • qTotal integer

      Number of values in the field.

      format = int32

    • qIsNum boolean

      This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional.

    • qField string

      Name of the field that is selected.

    • qLocked boolean

      This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional.

    • qOneAndOnlyOne boolean

      This parameter is displayed if its value is true. Property that is set to a field. Is set to true if the field cannot be unselected. This parameter is optional.

    • qTextSearch string

      Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional.

    • qSelectedCount integer

      Number of values that are selected.

      format = int32

    • qSelected string

      Values that are selected.

    • qRangeInfo array of objects

      Information about the range of selected values. Is empty if there is no range of selected values.

      Show qRangeInfo properties
      • qRangeLo number

        Lowest value in the range.

        default = -1e+300, format = double, default = -1e+300

      • qRangeHi number

        Highest value in the range.

        default = -1e+300, format = double, default = -1e+300

      • qMeasure string

        Label of the measure.
    • qSortIndex integer

      Sort index of the field. Indexing starts from 0.

      format = int32

    • qStateCounts object
      Show qStateCounts properties
      • qLocked integer

        Number of values in locked state.

        format = int32

      • qSelected integer

        Number of values in selected state.

        format = int32

      • qOption integer

        Number of values in optional state.

        format = int32

      • qDeselected integer

        Number of values in deselected state.

        format = int32

      • qAlternative integer

        Number of values in alternative state.

        format = int32

      • qExcluded integer

        Number of values in excluded state.

        format = int32

      • qSelectedExcluded integer

        Number of values in selected excluded state.

        format = int32

      • qLockedExcluded integer

        Number of values in locked excluded state.

        format = int32

    • qSelectedFieldSelectionInfo array of objects

      Information about the fields that are selected.

      Show qSelectedFieldSelectionInfo properties
      • qName string

        Name of the field.

      • qFieldSelectionMode string

        Can be one of: "NORMAL""AND""NOT"

    • qNotSelectedFieldSelectionInfo array of objects

      Information about the fields that are not selected.

      Show qNotSelectedFieldSelectionInfo properties
      • qName string

        Name of the field.

      • qFieldSelectionMode string

        Can be one of: "NORMAL""AND""NOT"

    • qSelectionThreshold integer

      Maximum values to show in the current selections. The default value is 6.

      format = int32

    • qReadableName string

      Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly.

    • qIsHidden boolean

      Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden.

    • qDimensionReferences array of objects
      Experimental

      List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem.

      Show qDimensionReferences properties
      • qId string

        Identifier of the associated dimension.

      • qLabel string

        Text label.
  • qStateName string

    Name of the alternate state. Default is current selections $ .

schemas SelectionObjectDef object

To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

Properties

"qSelectionObjectDef": {}

Properties

  • qStateName string

    Name of the alternate state. Default is current selections $ .

schemas Size object

Properties

  • qcx integer

    Number of pixels on the x axis.

    format = int32

  • qcy integer

    Number of pixels on the y axis.

    format = int32

schemas SortCriteria object

Properties

  • qSortByState integer

    Sorts the field values according to their logical state (selected, optional, alternative or excluded).

    format = int8

  • qSortByFrequency integer

    Sorts the field values by frequency (number of occurrences in the field).

    format = int8

  • qSortByNumeric integer

    Sorts the field values by numeric value.

    format = int8

  • qSortByAscii integer

    Sorts the field by alphabetical order.

    format = int8

  • qSortByLoadOrder integer

    Sorts the field values by the initial load order.

    format = int8

  • qSortByExpression integer

    Sorts the field by expression.

    format = int8

  • qExpression object
    Show qExpression properties
    • qv string

      Expression evaluated to dual.
  • qSortByGreyness integer

    format = int8

schemas SourceKeyRecord object

Properties

  • qKeyFields array of strings

    Name of the key field.

  • qTables array of strings

    Table the key belongs to.

schemas StateEnumType string

oneOf

  • L

    LOCKED

  • S

    SELECTED

  • O

    OPTION

  • D

    DESELECTED

  • A

    ALTERNATIVE

  • X

    EXCLUDED

  • XS

    EXCL_SELECTED

  • XL

    EXCL_LOCKED

  • NSTATES

schemas StateFieldValues object

Properties

  • qStateName string

    Name of the state.

  • qFieldValues array of objects

    The field values associated with the state.

    Show qFieldValues properties
    • qText string

      Text related to the field value. This parameter is optional.

    • qIsNumeric boolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumber number

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

schemas StaticContentList object

Properties

  • qItems array of objects

    Information about the list of content files.

    Show qItems properties
    • qUrlDef string

      Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located:

      • In the /content/ <content library name>/ folder are part of a global content library.
      • In the /appcontent/ folder are part of the app specific library. The content files are never embedded in the qvf file. In Qlik Sense Desktop, content files located:
      • In the /content/default/ folder are outside the qvf file.
      • In the /media/ folder are embedded in the qvf file.
    • qUrl string

      Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located:

      • In the /content/ <content library name>/ folder are part of a global content library.
      • In the /appcontent/ folder are part of the app specific library. The content files are never embedded in the qvf file. In Qlik Sense Desktop, content files located:
      • In the /content/default/ folder are outside the qvf file.
      • In the /media/ folder are embedded in the qvf file.

schemas StaticContentListItem object

In addition, this structure can return dynamic properties.

Properties

  • qUrlDef string

    Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located:

    • In the /content/ <content library name>/ folder are part of a global content library.
    • In the /appcontent/ folder are part of the app specific library. The content files are never embedded in the qvf file. In Qlik Sense Desktop, content files located:
    • In the /content/default/ folder are outside the qvf file.
    • In the /media/ folder are embedded in the qvf file.
  • qUrl string

    Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located:

    • In the /content/ <content library name>/ folder are part of a global content library.
    • In the /appcontent/ folder are part of the app specific library. The content files are never embedded in the qvf file. In Qlik Sense Desktop, content files located:
    • In the /content/default/ folder are outside the qvf file.
    • In the /media/ folder are embedded in the qvf file.

schemas StaticContentUrl object

In addition, this structure can return dynamic properties.

Properties

  • qUrl string

    Relative path of the thumbnail.

schemas StaticContentUrlDef object

In addition, this structure can contain dynamic properties.

Properties

  • qUrl string

    Relative path of the thumbnail.

schemas StringExpr object

Properties

  • qv string

    Expression evaluated to string.

schemas StringExpression object

Properties

Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

  • < expression > is a string
The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
A string expression is not evaluated, if the expression is surrounded by simple quotes.
The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.

Properties

  • qExpr string

schemas SymbolFrequency object

Properties

  • qSymbol object
    Show qSymbol properties
    • qText string

      String value of the symbol. This parameter is optional and present only if Symbol is a string.

    • qNumber number

      Numeric value of the symbol. NaN otherwise.

      format = double

  • qFrequency integer

    Frequency of the above symbol in the field

    format = int64

schemas SymbolValue object

Properties

  • qText string

    String value of the symbol. This parameter is optional and present only if Symbol is a string.

  • qNumber number

    Numeric value of the symbol. NaN otherwise.

    format = double

schemas TableProfilingData object

Properties

  • qNoOfRows integer

    Number of rows in the table.

    format = int64

  • qFieldProfiling array of objects

    Field values profiling info

    Show qFieldProfiling properties
    • qName string

      Name of the field.

    • qFieldTags array of strings

      List of tags related to the field.

    • qNumberFormat object

      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:

      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.

      Show qNumberFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qDistinctValues integer

      Number of distinct values

      format = int64

    • qDistinctNumericValues integer

      Number of distinct numeric values

      format = int64

    • qDistinctTextValues integer

      Number of distinct text values

      format = int64

    • qNumericValues integer

      Number of numeric values

      format = int64

    • qNullValues integer

      Number of null values

      format = int64

    • qTextValues integer

      Number of textual values

      format = int64

    • qNegValues integer

      Number of negative values

      format = int64

    • qPosValues integer

      Number of positive values

      format = int64

    • qZeroValues integer

      Number of zero values for numerical values

      format = int64

    • qSum number

      Sum of all numerical values. NaN otherwise.

      format = double

    • qSum2 number

      Squared sum of all numerical values. NaN otherwise.

      format = double

    • qAverage number

      Average of all numerical values. NaN otherwise.

      format = double

    • qMedian number

      Median of all numerical values. NaN otherwise.

      format = double

    • qStd number

      Standard deviation of numerical values. NaN otherwise.

      format = double

    • qMin number

      Minimum value of numerical values. NaN otherwise.

      format = double

    • qMax number

      Maximum value of numerical values. NaN otherwise.

      format = double

    • qSkewness number

      Skewness of the numerical values. NaN otherwise.

      format = double

    • qKurtosis number

      Kurtosis of the numerical values. NaN otherwise.

      format = double

    • qFractiles array of numbers

      The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

    • qEmptyStrings integer

      Number of empty strings

      format = int64

    • qMaxStringLen integer

      Maximum string length of textual values. 0 otherwise.

      format = int64

    • qMinStringLen integer

      Minimum string length of textual values. 0 otherwise.

      format = int64

    • qSumStringLen integer

      Sum of all characters in strings in the field

      format = int64

    • qAvgStringLen number

      Average string length of textual values. 0 otherwise.

      format = double

    • qFirstSorted string

      For textual values the first sorted string.

    • qLastSorted string

      For textual values the last sorted string.

    • qMostFrequent array of objects

      Three most frequent values and their frequencies

      Show qMostFrequent properties
      • qSymbol object
        Show qSymbol properties
        • qText string

          String value of the symbol. This parameter is optional and present only if Symbol is a string.

        • qNumber number

          Numeric value of the symbol. NaN otherwise.

          format = double

      • qFrequency integer

        Frequency of the above symbol in the field

        format = int64

    • qFrequencyDistribution object
      Show qFrequencyDistribution properties
      • qNumberOfBins integer

        Number of bins.

        format = int32

      • qBinsEdges array of numbers

        Bins edges.

      • qFrequencies array of integers

        Bins frequencies.
    • qDataEvenness number

      Data evenness aka Shannon's entropy normalized to [0,1]

      format = double

schemas TableRecord object

Properties

  • qName string

    Name of the table.

  • qLoose boolean

    This property is set to true if the table is loose.

  • qNoOfRows integer

    Number of rows in the table.

    format = int64

  • qFields array of objects

    Information about the fields in the table.

    Show qFields properties
    • qName string

      Name of the field.

    • qOriginalFields array of strings

      Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file.

    • qPresent boolean
    • qHasNull boolean

      This property is set to true if the field contains some Null values.

    • qHasWild boolean
    • qHasDuplicates boolean

      This property is set to true if the field contains some duplicate values.

    • qIsSynthetic boolean

      This property is set to true if the field contains a synthetic key.

    • qInformationDensity number

      Number of records that have values (for example, not NULL) in the field as compared to the total number of records in the table.

      format = double

    • qnNonNulls integer

      Number of values that are non Null.

      format = int64

    • qnRows integer

      Number of rows in the field.

      format = int64

    • qSubsetRatio number

      Number of distinct values in the field (in the current table) as compared to the total number of distinct values of this field (in all tables).

      format = double

    • qnTotalDistinctValues integer

      Number of distinct values in the field.

      format = int32

    • qnPresentDistinctValues integer

      format = int32

    • qKeyType string

      Can be one of: "NOT_KEY""ANY_KEY""PRIMARY_KEY""PERFECT_KEY"

    • qComment string

      Comment related to the field.

    • qTags array of strings

      List of tags related to the field.

    • qDerivedFields array of objects

      List of the derived fields.

      Show qDerivedFields properties
      • qDefinitionName string

        Name of the derived definition.

      • qTags array of strings

        List of tags.

      • qActive boolean

        Is set to true is the derived field is in use.
    • qIsFieldOnTheFly boolean

      default = false

    • qReadableName string
  • qPos object
    Show qPos properties
    • qx integer

      x-coordinate in pixels. The origin is the top left of the screen.

      format = int32

    • qy integer

      y-coordinate in pixels. The origin is the top left of the screen.

      format = int32

  • qComment string

    Comment related to the table.

  • qIsDirectDiscovery boolean

    If set to true, Direct Discovery is used. Direct Discovery fields are not loaded into memory and remain in the external database.

  • qIsSynthetic boolean

    This property is set to true if the table contains a synthetic key.

  • qTableTags array of strings

    List of tags related to the table.

  • qProfilingData object
    Show qProfilingData properties
    • qNoOfRows integer

      Number of rows in the table.

      format = int64

    • qFieldProfiling array of objects

      Field values profiling info

      Show qFieldProfiling properties
      • qName string

        Name of the field.

      • qFieldTags array of strings

        List of tags related to the field.

      • qNumberFormat object

        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:

        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.

        Show qNumberFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qDistinctValues integer

        Number of distinct values

        format = int64

      • qDistinctNumericValues integer

        Number of distinct numeric values

        format = int64

      • qDistinctTextValues integer

        Number of distinct text values

        format = int64

      • qNumericValues integer

        Number of numeric values

        format = int64

      • qNullValues integer

        Number of null values

        format = int64

      • qTextValues integer

        Number of textual values

        format = int64

      • qNegValues integer

        Number of negative values

        format = int64

      • qPosValues integer

        Number of positive values

        format = int64

      • qZeroValues integer

        Number of zero values for numerical values

        format = int64

      • qSum number

        Sum of all numerical values. NaN otherwise.

        format = double

      • qSum2 number

        Squared sum of all numerical values. NaN otherwise.

        format = double

      • qAverage number

        Average of all numerical values. NaN otherwise.

        format = double

      • qMedian number

        Median of all numerical values. NaN otherwise.

        format = double

      • qStd number

        Standard deviation of numerical values. NaN otherwise.

        format = double

      • qMin number

        Minimum value of numerical values. NaN otherwise.

        format = double

      • qMax number

        Maximum value of numerical values. NaN otherwise.

        format = double

      • qSkewness number

        Skewness of the numerical values. NaN otherwise.

        format = double

      • qKurtosis number

        Kurtosis of the numerical values. NaN otherwise.

        format = double

      • qFractiles array of numbers

        The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

      • qEmptyStrings integer

        Number of empty strings

        format = int64

      • qMaxStringLen integer

        Maximum string length of textual values. 0 otherwise.

        format = int64

      • qMinStringLen integer

        Minimum string length of textual values. 0 otherwise.

        format = int64

      • qSumStringLen integer

        Sum of all characters in strings in the field

        format = int64

      • qAvgStringLen number

        Average string length of textual values. 0 otherwise.

        format = double

      • qFirstSorted string

        For textual values the first sorted string.

      • qLastSorted string

        For textual values the last sorted string.

      • qMostFrequent array of objects

        Three most frequent values and their frequencies

        Show qMostFrequent properties
        • qSymbol object
          Show qSymbol properties
          • qText string

            String value of the symbol. This parameter is optional and present only if Symbol is a string.

          • qNumber number

            Numeric value of the symbol. NaN otherwise.

            format = double

        • qFrequency integer

          Frequency of the above symbol in the field

          format = int64

      • qFrequencyDistribution object
        Show qFrequencyDistribution properties
        • qNumberOfBins integer

          Number of bins.

          format = int32

        • qBinsEdges array of numbers

          Bins edges.

        • qFrequencies array of integers

          Bins frequencies.
      • qDataEvenness number

        Data evenness aka Shannon's entropy normalized to [0,1]

        format = double

schemas TableRow object

Properties

  • qValue array of objects

    Array of field values.

    Show qValue properties
    • qText string

      Text related to the field value. This parameter is optional.

    • qIsNumeric boolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumber number

      Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

      format = double

schemas TableViewBroomPointSaveInfo object

Properties

  • qPos object
    Show qPos properties
    • qx integer

      x-coordinate in pixels. The origin is the top left of the screen.

      format = int32

    • qy integer

      y-coordinate in pixels. The origin is the top left of the screen.

      format = int32

  • qTable string

    Name of the table.

  • qFields array of strings

    List of fields in the table.

schemas TableViewConnectionPointSaveInfo object

Properties

  • qPos object
    Show qPos properties
    • qx integer

      x-coordinate in pixels. The origin is the top left of the screen.

      format = int32

    • qy integer

      y-coordinate in pixels. The origin is the top left of the screen.

      format = int32

  • qFields array of strings

    List of the fields in the table.

schemas TableViewCtlSaveInfo object

Properties

  • qInternalView object
    Show qInternalView properties
    • qTables array of objects

      List of the tables in the database model viewer.

      Show qTables properties
      • qPos object
        Show qPos properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qCaption string

        Table name.
    • qBroomPoints array of objects

      List of the broom points in the database model viewer. Not used in Qlik Sense.

      Show qBroomPoints properties
      • qPos object
        Show qPos properties
        • qx integer

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qy integer

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

      • qTable string

        Name of the table.

      • qFields array of strings

        List of fields in the table.
    • qConnectionPoints array of objects

      List of connection points in the database model viewer. Not used in Qlik Sense.

      Show qConnectionPoints properties
      • qPos object
        Show qPos properties
        • qx integer

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qy integer

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

      • qFields array of strings

        List of the fields in the table.
    • qZoomFactor number

      Zoom factor in the database model viewer. The default value is 1.0.

      default = 1, format = double, default = 1

  • qSourceView object
    Show qSourceView properties
    • qTables array of objects

      List of the tables in the database model viewer.

      Show qTables properties
      • qPos object
        Show qPos properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qCaption string

        Table name.
    • qBroomPoints array of objects

      List of the broom points in the database model viewer. Not used in Qlik Sense.

      Show qBroomPoints properties
      • qPos object
        Show qPos properties
        • qx integer

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qy integer

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

      • qTable string

        Name of the table.

      • qFields array of strings

        List of fields in the table.
    • qConnectionPoints array of objects

      List of connection points in the database model viewer. Not used in Qlik Sense.

      Show qConnectionPoints properties
      • qPos object
        Show qPos properties
        • qx integer

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qy integer

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

      • qFields array of strings

        List of the fields in the table.
    • qZoomFactor number

      Zoom factor in the database model viewer. The default value is 1.0.

      default = 1, format = double, default = 1

schemas TableViewDlgSaveInfo object

Properties

  • qPos object
    Show qPos properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qCtlInfo object
    Show qCtlInfo properties
    • qInternalView object
      Show qInternalView properties
      • qTables array of objects

        List of the tables in the database model viewer.

        Show qTables properties
        • qPos object
          Show qPos properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qCaption string

          Table name.
      • qBroomPoints array of objects

        List of the broom points in the database model viewer. Not used in Qlik Sense.

        Show qBroomPoints properties
        • qPos object
          Show qPos properties
          • qx integer

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qy integer

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

        • qTable string

          Name of the table.

        • qFields array of strings

          List of fields in the table.
      • qConnectionPoints array of objects

        List of connection points in the database model viewer. Not used in Qlik Sense.

        Show qConnectionPoints properties
        • qPos object
          Show qPos properties
          • qx integer

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qy integer

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

        • qFields array of strings

          List of the fields in the table.
      • qZoomFactor number

        Zoom factor in the database model viewer. The default value is 1.0.

        default = 1, format = double, default = 1

    • qSourceView object
      Show qSourceView properties
      • qTables array of objects

        List of the tables in the database model viewer.

        Show qTables properties
        • qPos object
          Show qPos properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qCaption string

          Table name.
      • qBroomPoints array of objects

        List of the broom points in the database model viewer. Not used in Qlik Sense.

        Show qBroomPoints properties
        • qPos object
          Show qPos properties
          • qx integer

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qy integer

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

        • qTable string

          Name of the table.

        • qFields array of strings

          List of fields in the table.
      • qConnectionPoints array of objects

        List of connection points in the database model viewer. Not used in Qlik Sense.

        Show qConnectionPoints properties
        • qPos object
          Show qPos properties
          • qx integer

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qy integer

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

        • qFields array of strings

          List of the fields in the table.
      • qZoomFactor number

        Zoom factor in the database model viewer. The default value is 1.0.

        default = 1, format = double, default = 1

  • qMode integer

    View mode to display when opening Qlik Sense data model viewer. One of:

    • 0 for internal view mode.
    • 1 for source view mode.

    format = int32

schemas TableViewSaveInfo object

Properties

  • qTables array of objects

    List of the tables in the database model viewer.

    Show qTables properties
    • qPos object
      Show qPos properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qCaption string

      Table name.
  • qBroomPoints array of objects

    List of the broom points in the database model viewer. Not used in Qlik Sense.

    Show qBroomPoints properties
    • qPos object
      Show qPos properties
      • qx integer

        x-coordinate in pixels. The origin is the top left of the screen.

        format = int32

      • qy integer

        y-coordinate in pixels. The origin is the top left of the screen.

        format = int32

    • qTable string

      Name of the table.

    • qFields array of strings

      List of fields in the table.
  • qConnectionPoints array of objects

    List of connection points in the database model viewer. Not used in Qlik Sense.

    Show qConnectionPoints properties
    • qPos object
      Show qPos properties
      • qx integer

        x-coordinate in pixels. The origin is the top left of the screen.

        format = int32

      • qy integer

        y-coordinate in pixels. The origin is the top left of the screen.

        format = int32

    • qFields array of strings

      List of the fields in the table.
  • qZoomFactor number

    Zoom factor in the database model viewer. The default value is 1.0.

    default = 1, format = double, default = 1

schemas TableViewTableWinSaveInfo object

Properties

  • qPos object
    Show qPos properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qCaption string

    Table name.

schemas TextMacro object

Properties

  • qTag string

    Name of the variable.

  • qRefSeqNo integer

    Order in which the variable was referenced during the script execution. The same number sequence is used for both qRefSeqNo and qSetSeqNo .

    format = int32

  • qSetSeqNo integer

    Order in which the variable was updated during the script execution. The same number sequence is used for both qRefSeqNo and qSetSeqNo .

    format = int32

  • qDisplayString string

    Variable value.

  • qIsSystem boolean

    Is set to true if the variable is a system variable.

    default = false

  • qIsReserved boolean

    Is set to true if the variable is a reserved variable.

    default = false

schemas TotalMode string

oneOf

  • TOTAL_OFF

  • TOTAL_EXPR

schemas TransformAppParameters object

Properties

  • qName string

    The name (title) of the application

  • qSpaceId string

    ID of the space where the app is to be created. Empty value implies Personal space

  • qScriptParameterPrefix string

    Prefix to be used on inserted ScriptParameters, only applicable for template apps

schemas TransformAppResult object

Properties

  • qAppId string

    ID of created App

schemas TreeData object

Renders the properties of a TreeData object. Is the layout for TreeDataDef. For more information about the definition of TreeData, see Generic object.

To retrieve data from the TreeData object, use the method called GetHyperCubeTreeData.

Properties

  • qStateName string

    Name of the alternate state. Default is current selections $ .

  • qNodesOnDim array of integers

    The total number of nodes on each dimension.

  • qError object
    Show qError properties
    • qErrorCode integer

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContext string

      Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

    • qExtendedMessage string

      Internal information from the server. This parameter is optional.
  • qDimensionInfo array of objects

    Information on the dimension.

    Show qDimensionInfo properties
    • qFallbackTitle string

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

    • qApprMaxGlyphCount integer

      Length of the longest value in the field.

      format = int32

    • qCardinal integer Deprecated

      Number of distinct field values.

      format = int32

    • qLocked boolean

      Is set to true if the field is locked.

    • qSortIndicator string

      Can be one of: "N""A""D"

    • qGroupFallbackTitles array of strings

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

    • qGroupPos integer

      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.

      format = int32

    • qStateCounts object
      Show qStateCounts properties
      • qLocked integer

        Number of values in locked state.

        format = int32

      • qSelected integer

        Number of values in selected state.

        format = int32

      • qOption integer

        Number of values in optional state.

        format = int32

      • qDeselected integer

        Number of values in deselected state.

        format = int32

      • qAlternative integer

        Number of values in alternative state.

        format = int32

      • qExcluded integer

        Number of values in excluded state.

        format = int32

      • qSelectedExcluded integer

        Number of values in selected excluded state.

        format = int32

      • qLockedExcluded integer

        Number of values in locked excluded state.

        format = int32

    • qTags array of strings

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

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qDimensionType string

      Can be one of: "D""N""T"

    • qReverseSort boolean

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

    • qGrouping string

      Can be one of: "N""H""C"

    • qIsSemantic boolean

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

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • 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.

    • qGroupFieldDefs array of strings

      Array of field names.

    • qMin number

      Minimum value.

      format = double

    • qMax number

      Maximum value.

      format = double

    • qContinuousAxes boolean

      Is continuous axis used.

    • qIsCyclic boolean

      Is a cyclic dimension used.

    • qDerivedField boolean

      Is derived field is used as a dimension.

    • qMeasureInfo array of objects

      A List of measures to be calculated on this TreeDimension.

      Show qMeasureInfo properties
      • qFallbackTitle string

        Corresponds to the label of the measure. If the label is not defined then the measure name is used.

      • qApprMaxGlyphCount integer

        Length of the longest value in the field.

        format = int32

      • qCardinal integer

        Number of distinct field values.

        format = int32

      • qSortIndicator string

        Can be one of: "N""A""D"

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qMin number

        Lowest value in the range.

        format = double

      • qMax number

        Highest value in the range.

        format = double

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qReverseSort boolean

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

      • 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 expression.

      • qAttrExprInfo array of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qAttrDimInfo array of objects

        List of attribute dimensions.

        Show qAttrDimInfo properties
        • qCardinal integer

          Cardinality of the attribute expression.

          format = int32

        • qSize object
          Show qSize properties
          • qcx integer

            Number of pixels on the x axis.

            format = int32

          • qcy integer

            Number of pixels on the y axis.

            format = int32

        • qFallbackTitle string

          The title for the attribute dimension.

        • qLocked boolean

          The Locked value of the dimension.

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

      • qCalcCondMsg string

        The message displayed if calculation condition is not fulfilled.

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qTrendLines array of objects
        Experimental

        Calculated trendlines

        Show qTrendLines properties
        • qType string

          Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qCoeff array of numbers

          Coefficent c0..cN depending on the trendline type.

        • qR2 number

          R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

          format = double

        • qExpression string

          Trendline expression

        • qElemNo integer

          Inner Dim elem no

          format = int32

      • qMiniChart object
        Show qMiniChart properties
        • qYMin number

          format = double

        • qYMax number

          format = double

        • qXMin number

          format = double

        • qXMax number

          format = double

        • qAttrExprInfo array of objects

          List of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • 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 expression.
        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
    • qAttrExprInfo array of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qFallbackTitle string
      • qMinText string

        String version of the minimum Value.

      • qMaxText string

        String version of the maximum Value.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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 expression.
    • qAttrDimInfo array of objects

      List of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinal integer

        Cardinality of the attribute expression.

        format = int32

      • qSize object
        Show qSize properties
        • qcx integer

          Number of pixels on the x axis.

          format = int32

        • qcy integer

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitle string

        The title for the attribute dimension.

      • qLocked boolean

        The Locked value of the dimension.

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsg string

      The message displayed if calculation condition is not fulfilled.

    • qIsCalculated boolean

      True if this is a calculated dimension.

      default = false

    • qIsOneAndOnlyOne boolean

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

    • qCardinalities object
      Show qCardinalities properties
      • qCardinal integer

        Number of distinct field values.

        format = int32

      • qHypercubeCardinal integer

        Number of distinct hypercube values.

        format = int32

      • qAllValuesCardinal integer

        Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

        default = -1, format = int32, default = -1

    • qLibraryId string

      Refers to a dimension stored in the library.

    • qEffectiveDimensionName string
      Experimental

      The expanded and stripped dimension name used internally in engine.
  • qEffectiveInterColumnSortOrder array of integers

    Defines the order of the dimenion levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2.

  • qHasOtherValues boolean

    True if other row exists.

  • qTitle string

    Title of the TreeData object, for example the title of a chart.

  • qLastExpandedPos object
    Show qLastExpandedPos properties
    • qx integer

      Position of the cell on the x-axis.

      format = int32

    • qy integer

      Position of the cell on the y-axis.

      format = int32

  • qCalcCondMsg string

    The message displayed if calculation condition is not fulfilled.

  • qTreeDataPages array of objects

    Set of data. Is empty if nothing has been defined in qInitialDataFetch in TreeDataDef.

    Show qTreeDataPages properties
    • qText string

      The text version of the value, if available.

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qElemNo integer

      Element number.

      format = int32

    • qGroupPos integer

      The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

      format = int32

    • qGroupSize integer

      Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

      format = int32

    • qRow integer

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qValues array of objects

      The measures for this node.

      Show qValues properties
      • qText string

        The text version of the value, if available.

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qNodes array of undefineds

      The children of this node in the fetched tree structure.

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

    • qMaxPos array of numbers

      Total of the positive values in the current group of cells.

    • qMinNeg array of numbers

      Total of the negative values in the current group of cells.

    • qCanExpand boolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapse boolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qState string

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qTreePath array of integers

      The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.
  • qMeasureInfo array of objects

    Information on the measures calculated on the whole tree.

    Show qMeasureInfo properties
    • qFallbackTitle string

      Corresponds to the label of the measure. If the label is not defined then the measure name is used.

    • qApprMaxGlyphCount integer

      Length of the longest value in the field.

      format = int32

    • qCardinal integer

      Number of distinct field values.

      format = int32

    • qSortIndicator string

      Can be one of: "N""A""D"

    • qNumFormat object

      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:

      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.

      Show qNumFormat properties
      • qType string

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDec integer

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThou integer

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmt string

        Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

      • qDec string

        Defines the decimal separator. Example: .

      • qThou string

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qMin number

      Lowest value in the range.

      format = double

    • qMax number

      Highest value in the range.

      format = double

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContext string

        Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

      • qExtendedMessage string

        Internal information from the server. This parameter is optional.
    • qReverseSort boolean

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

    • 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 expression.

    • qAttrExprInfo array of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMin number

        Minimum value.

        format = double

      • qMax number

        Maximum value.

        format = double

      • qFallbackTitle string
      • qMinText string

        String version of the minimum Value.

      • qMaxText string

        String version of the maximum Value.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • 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 expression.
    • qAttrDimInfo array of objects

      List of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinal integer

        Cardinality of the attribute expression.

        format = int32

      • qSize object
        Show qSize properties
        • qcx integer

          Number of pixels on the x axis.

          format = int32

        • qcy integer

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitle string

        The title for the attribute dimension.

      • qLocked boolean

        The Locked value of the dimension.

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qIsCalculated boolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsg string

      The message displayed if calculation condition is not fulfilled.

    • qLibraryId string

      Refers to a dimension stored in the library.

    • qTrendLines array of objects
      Experimental

      Calculated trendlines

      Show qTrendLines properties
      • qType string

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qCoeff array of numbers

        Coefficent c0..cN depending on the trendline type.

      • qR2 number

        R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

        format = double

      • qExpression string

        Trendline expression

      • qElemNo integer

        Inner Dim elem no

        format = int32

    • qMiniChart object
      Show qMiniChart properties
      • qYMin number

        format = double

      • qYMax number

        format = double

      • qXMin number

        format = double

      • qXMax number

        format = double

      • qAttrExprInfo array of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qFallbackTitle string
        • qMinText string

          String version of the minimum Value.

        • qMaxText string

          String version of the maximum Value.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • 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 expression.
      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.

schemas TreeDataDef object

Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

Properties

  • qStateName string

    Name of the alternate state. Default is current selections $ .

  • qDimensions array of objects

    Array of dimensions.

    Show qDimensions properties
    • qLibraryId string

      Refers to a dimension stored in the library.

    • qDef object
      Show qDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

      • qFieldLabels array of strings

        Array of field labels. This parameter is optional.

      • qSortCriterias array of objects

        Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

        Show qSortCriterias properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qNumberPresentations array of objects

        Defines the format of the value. This parameter is optional.

        Show qNumberPresentations properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qReverseSort boolean

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

      • qActiveField integer

        Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

        format = int32

      • qLabelExpression string

        Label expression. This parameter is optional.

      • qAlias string

        Alias of the dimension.
    • qValueExprs array of objects

      List of measures.

      Show qValueExprs properties
      • qLibraryId string

        Refers to a measure stored in the library.

      • qDef object
        Show qDef properties
        • qLabel string

          Name of the measure. An empty string is returned as a default value. This parameter is optional.

        • qDescription string

          Description of the measure. An empty string is returned as a default value. This parameter is optional.

        • qTags array of strings

          Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

        • qGrouping string

          Can be one of: "N""H""C"

        • qDef string

          Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRelative boolean

          If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

        • qBrutalSum boolean

          If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

        • qAggrFunc string

          Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

        • qAccumulate integer
          • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

          format = int32

        • qReverseSort boolean

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

        • qActiveExpression integer

          Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

          format = int32

        • qExpressions array of strings

          Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

        • qLabelExpression string

          Label expression. This parameter is optional.
      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qAttributeExpressions array of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpression string

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryId string

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttribute boolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabel string

          Label of the attribute expression.

        • qLabelExpression string

          Optional expression used for dynamic label.
      • qAttributeDimensions array of objects

        List of attribute dimensions.

        Show qAttributeDimensions properties
        • qDef string

          Expression or field name.

        • qLibraryId string

          LibraryId for dimension.

        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttribute boolean

          If set to true, this attribute will not affect the number of rows in the cube.
      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTrendLines array of objects
        Experimental

        Specifies trendlines for this measure.

        Show qTrendLines properties
        • qType string

          Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

        • qXColIx integer

          The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

          default = -1, format = int32, default = -1

        • qCalcR2 boolean

          Set to true to calulatate the R2 score

          default = false

        • qContinuousXAxis string

          Can be one of: "Never""Possible""Time"

        • qMultiDimMode string

          Can be one of: "Multi""Sum"

      • qMiniChartDef object
        Show qMiniChartDef properties
        • qDef string

          Expression or field name.

        • qLibraryId string

          LibraryId for dimension.

        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qMaxNumberPoints integer

          default = -1, format = int32, default = -1

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            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:

            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.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qNullSuppression boolean

          If set to true, no null values are returned.
    • qNullSuppression boolean

      If set to true, no null values are returned.

    • qOtherTotalSpec object
      Show qOtherTotalSpec properties
      • qOtherMode string

        Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

      • qOtherCounted object
        Show qOtherCounted properties
        • qv string

          Expression evaluated to dual.
      • qOtherLimit object
        Show qOtherLimit properties
        • qv string

          Expression evaluated to dual.
      • qOtherLimitMode string

        Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

      • qSuppressOther boolean

        If set to true, the group Others is not displayed as a dimension value. The default value is false.

        default = false

      • qForceBadValueKeeping boolean

        This parameter is used when qOtherMode is set to:

        • OTHER_ABS_LIMITED
        • OTHER_REL_LIMITED
        • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

        and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

        default = true

      • qApplyEvenWhenPossiblyWrongResult boolean

        Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

        default = true

      • qGlobalOtherGrouping boolean

        This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

        default = false

      • qOtherCollapseInnerDimensions boolean

        If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

        default = false

      • qOtherSortMode string

        Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

      • qTotalMode string

        Can be one of: "TOTAL_OFF""TOTAL_EXPR"

      • qReferencedExpression object
        Show qReferencedExpression properties
        • qv string

          Expression evaluated to string.
    • qShowAll boolean

      If set to true, all dimension values are shown.

    • qOtherLabel object
      Show qOtherLabel properties
      • qv string

        Expression evaluated to string.
    • qTotalLabel object
      Show qTotalLabel properties
      • qv string

        Expression evaluated to string.
    • qCalcCondition object
      Show qCalcCondition properties
      • qCond object
        Show qCond properties
        • qv string

          Expression evaluated to dual.
      • qMsg object
        Show qMsg properties
        • qv string

          Expression evaluated to string.
    • qAttributeExpressions array of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpression string

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryId string

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttribute boolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabel string

        Label of the attribute expression.

      • qLabelExpression string

        Optional expression used for dynamic label.
    • qAttributeDimensions array of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDef string

        Expression or field name.

      • qLibraryId string

        LibraryId for dimension.

      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qAttribute boolean

        If set to true, this attribute will not affect the number of rows in the cube.
  • qInterColumnSortOrder array of integers

    Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

  • qSuppressZero boolean

    Removes zero values.

    default = false

  • qSuppressMissing boolean

    Removes missing values.

    default = false

  • qOpenFullyExpanded boolean

    If this property is set to true, the cells are opened expanded. The default value is false.

    default = false

  • qPopulateMissing boolean

    If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

    default = false

  • qCalcCondition object
    Show qCalcCondition properties
    • qCond object
      Show qCond properties
      • qv string

        Expression evaluated to dual.
    • qMsg object
      Show qMsg properties
      • qv string

        Expression evaluated to string.
  • qTitle object
    Show qTitle properties
    • qv string

      Expression evaluated to string.
  • qInitialDataFetch array of objects

    Initial data set. This property is optional.

    Show qInitialDataFetch properties
    • qMaxNbrOfNodes integer

      Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

      format = int32

    • qTreeNodes array of objects

      Defines areas of the tree to be fetched. Areas must be defined left to right.

      Show qTreeNodes properties
      • qArea object
        Show qArea properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qAllValues boolean

        When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
    • qTreeLevels object
      Show qTreeLevels properties
      • qLeft integer

        The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

        format = int32

      • qDepth integer

        Number of dimensions to include in the tree.

        default = -1, format = int32, default = -1

  • qExpansionState array of objects
    Experimental

    Expansion state per dimension.

    Show qExpansionState properties
    • qExcludeList boolean
    • qPos object
      Show qPos properties
      • qDimName string
      • qElemNo array of integers
      • qElemValues array of strings
  • qValueExprs array of objects

    List of measures to calculate on the whole tree.

    Show qValueExprs properties
    • qLibraryId string

      Refers to a measure stored in the library.

    • qDef object
      Show qDef properties
      • qLabel string

        Name of the measure. An empty string is returned as a default value. This parameter is optional.

      • qDescription string

        Description of the measure. An empty string is returned as a default value. This parameter is optional.

      • qTags array of strings

        Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

      • qGrouping string

        Can be one of: "N""H""C"

      • qDef string

        Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRelative boolean

        If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

      • qBrutalSum boolean

        If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

      • qAggrFunc string

        Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

      • qAccumulate integer
        • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

        format = int32

      • qReverseSort boolean

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

      • qActiveExpression integer

        Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

        format = int32

      • qExpressions array of strings

        Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

      • qLabelExpression string

        Label expression. This parameter is optional.
    • qSortBy object
      Show qSortBy properties
      • qSortByState integer

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequency integer

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumeric integer

        Sorts the field values by numeric value.

        format = int8

      • qSortByAscii integer

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrder integer

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpression integer

        Sorts the field by expression.

        format = int8

      • qExpression object
        Show qExpression properties
        • qv string

          Expression evaluated to dual.
      • qSortByGreyness integer

        format = int8

    • qAttributeExpressions array of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpression string

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryId string

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttribute boolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormat object

        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:

        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.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabel string

        Label of the attribute expression.

      • qLabelExpression string

        Optional expression used for dynamic label.
    • qAttributeDimensions array of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDef string

        Expression or field name.

      • qLibraryId string

        LibraryId for dimension.

      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qAttribute boolean

        If set to true, this attribute will not affect the number of rows in the cube.
    • qCalcCond object
      Show qCalcCond properties
      • qv string

        Expression evaluated to dual.
    • qCalcCondition object
      Show qCalcCondition properties
      • qCond object
        Show qCond properties
        • qv string

          Expression evaluated to dual.
      • qMsg object
        Show qMsg properties
        • qv string

          Expression evaluated to string.
    • qTrendLines array of objects
      Experimental

      Specifies trendlines for this measure.

      Show qTrendLines properties
      • qType string

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qXColIx integer

        The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

        default = -1, format = int32, default = -1

      • qCalcR2 boolean

        Set to true to calulatate the R2 score

        default = false

      • qContinuousXAxis string

        Can be one of: "Never""Possible""Time"

      • qMultiDimMode string

        Can be one of: "Multi""Sum"

    • qMiniChartDef object
      Show qMiniChartDef properties
      • qDef string

        Expression or field name.

      • qLibraryId string

        LibraryId for dimension.

      • qSortBy object
        Show qSortBy properties
        • qSortByState integer

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequency integer

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumeric integer

          Sorts the field values by numeric value.

          format = int8

        • qSortByAscii integer

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrder integer

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpression integer

          Sorts the field by expression.

          format = int8

        • qExpression object
          Show qExpression properties
          • qv string

            Expression evaluated to dual.
        • qSortByGreyness integer

          format = int8

      • qOtherTotalSpec object
        Show qOtherTotalSpec properties
        • qOtherMode string

          Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

        • qOtherCounted object
          Show qOtherCounted properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimit object
          Show qOtherLimit properties
          • qv string

            Expression evaluated to dual.
        • qOtherLimitMode string

          Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

        • qSuppressOther boolean

          If set to true, the group Others is not displayed as a dimension value. The default value is false.

          default = false

        • qForceBadValueKeeping boolean

          This parameter is used when qOtherMode is set to:

          • OTHER_ABS_LIMITED
          • OTHER_REL_LIMITED
          • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

          and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

          default = true

        • qApplyEvenWhenPossiblyWrongResult boolean

          Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

          default = true

        • qGlobalOtherGrouping boolean

          This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

          default = false

        • qOtherCollapseInnerDimensions boolean

          If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

          default = false

        • qOtherSortMode string

          Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

        • qTotalMode string

          Can be one of: "TOTAL_OFF""TOTAL_EXPR"

        • qReferencedExpression object
          Show qReferencedExpression properties
          • qv string

            Expression evaluated to string.
      • qMaxNumberPoints integer

        default = -1, format = int32, default = -1

      • qAttributeExpressions array of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpression string

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryId string

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttribute boolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormat object

          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:

          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.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabel string

          Label of the attribute expression.

        • qLabelExpression string

          Optional expression used for dynamic label.
      • qNullSuppression boolean

        If set to true, no null values are returned.
  • qContextSetExpression string

    Set expression valid for the whole cube, limiting computations to the specified set.

schemas UndoInfo object

Displays information about the number of possible undos and redos. Is the layout for UndoInfoDef.

Properties

  • qUndoCount integer

    Number of possible undos.

    format = int32

  • qRedoCount integer

    Number of possible redos.

    format = int32

schemas UndoInfoDef object

Defines if an object should contain information on the number of possible undo and redo.

Properties

"qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

schemas UsageEnum string

oneOf

  • ANALYTICS

  • DATA_PREPARATION

  • DATAFLOW_PREP

  • SINGLE_TABLE_PREP

  • DIRECT_QUERY_MODE

schemas ValueExpr object

Properties

  • qv string

    Expression evaluated to dual.

schemas ValueExpression object

Properties

Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

  • < expression > is a string.
The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
The expression is evaluated as a numeric.

Properties

  • qExpr string

schemas VariableList object

Lists the variables in an app. Is the layout for VariableListDef.

Properties

  • qItems array of objects

    List of the variables.

    Show qItems properties
    • qName string

      Name of the variable.

    • qDescription string

      Description of the variable.

    • qDefinition string

      Definition of the variable. It can be a value or an expression.

    • qIsConfig boolean

      If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false.

      default = false

    • qIsReserved boolean

      If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples:

      • ScriptError is a reserved variable, set by the engine.
      • DayNames is a reserved variable, set by the user.

      default = false

    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qData object

      Contains dynamic JSON data specified by the client.

    • qIsScriptCreated boolean

      If set to true, it means that the variable was defined via script.

schemas VariableListDef object

Defines the list of variables in an app.

Properties

  • qType string

    Type of variables to include in the list.

  • qShowReserved boolean

    Shows the reserved variables if set to true.

  • qShowConfig boolean

    Shows the system variables if set to true.

  • qData object

    Contains dynamic JSON data specified by the client.

  • qShowSession boolean

    Shows the session variables if set to true.