Qlik Sense Engine (qix)

The JSON-RPC API over WebSocket API that enables you to interact with the Qlik Associative Engine for Qlik Sense applications.

Download specification

schemas

schemas AlfaNumString object

Deprecated

Properties

  • qStringstring

    Calculated value.

  • qIsNumboolean

    Is set to true if the value is a numeric.

schemas AlternateStateData object

Properties

  • qStateNamestring

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

  • qFieldItemsarray of objects

    List of the selections.

    Show qFieldItems properties
    • qDefobject
      Show qDef properties
      • qNamestring

        Name of the field.

      • qTypestring

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

    • qLockedboolean

      Indicates if the field is locked. Default is false.

    • qSelectInfoobject
      Show qSelectInfo properties
      • qTextSearchstring

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

      • qRangeLonumber

        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

      • qRangeHinumber

        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

      • qNumberFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRangeInfoarray 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
        • qRangeLonumber

          Lowest value in the range.

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

        • qRangeHinumber

          Highest value in the range.

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

        • qMeasurestring

          Label of the measure.
      • qSoftLockboolean

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

        default = false

      • qContinuousRangeInfoarray of objects

        List of information about ranges for selections.

        Show qContinuousRangeInfo properties
        • qMinnumber

          Lowest value in the range

          format = double

        • qMaxnumber

          Highest value in the range

          format = double

        • qMinInclEqboolean

          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.

        • qMaxInclEqboolean

          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.
      • qSelectFieldSearchboolean

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

        default = false

    • qValuesarray of objects
      Show qValues properties
      • qTextstring

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

      • qIsNumericboolean

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

      • qNumbernumber

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

        format = double

    • qExcludedValuesarray of objects

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

      Show qExcludedValues properties
      • qTextstring

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

      • qIsNumericboolean

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

      • qNumbernumber

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

        format = double

    • qAndModeboolean

      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.

    • qOneAndOnlyOneboolean

      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.

schemas AppEntry object

Properties

  • qIDstring

    Identifier of the app.

  • qTitlestring

    Title of the app.

  • qPathstring

    Path of the app.

  • qLastReloadTimestring

    Last reload time of the app.

  • qReadOnlyboolean

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

  • qMetaobject

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qThumbnailobject
    In addition, this structure can return dynamic properties.
    Show qThumbnail properties
    • qUrlstring

      Relative path of the thumbnail.
  • qFileSizeinteger

    format = int64

  • qHasSectionAccessboolean

    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

  • qItemsarray of objects

    Information about the list of dimensions.

    Show qItems properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      Layout for NxMetaDef.

      Show qMeta properties
      • qNamestring

        Name. This property is optional.
    • qDataobject

      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

  • qTypestring

    Type of the app list.

  • qDataobject

    Contains dynamic JSON data specified by the client.

schemas AppScript object

Properties

  • qScriptstring

    Script text.

  • qMetaobject

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qIsLockedboolean

    True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS.

schemas AppScriptMeta object

Experimental

Properties

  • qMetaobject

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qIsLockedboolean

    True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS.

schemas ApplyGroupStateWarning object

Experimental

Properties

  • qStateobject
    Experimental
    Show qState properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      String defining the active field.
  • qTypestring

    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

  • qApplySuccessboolean

    When true, the operation was successful.

  • qWarningsarray of objects
    Experimental

    Lists which states failed to be applied and why.

    Show qWarnings properties
    • qStateobject
      Experimental
      Show qState properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

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

        String defining the active field.
    • qTypestring

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

schemas ArrayOfNxValuePoint object[]

Element properties

  • qLabelstring

    Label of the cell. This parameter is optional.

  • qTextstring

    Some text related to the cell.

  • qNumnumber

    Value of the cell.

    format = double

  • qTypestring

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

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

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

        format = double

  • qAttrDimsobject
    Show qAttrDims properties
    • qValuesarray of objects

      List of values.

      Show qValues properties
      • qTextstring

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

      • qElemNointeger

        Element number.

        format = int32

schemas AssociationScore object

Properties

  • qFieldPairNamestring

    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]: .

  • qScoreSummaryinteger

    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

  • qField1Scoresobject
    Show qField1Scores properties
    • qFieldNamestring

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

    • qReadableNamestring
    • qCardinalRationumber

      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

    • qSymbolScorenumber

      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

    • qRowScorenumber

      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

  • qField2Scoresobject
    Show qField2Scores properties
    • qFieldNamestring

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

    • qReadableNamestring
    • qCardinalRationumber

      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

    • qSymbolScorenumber

      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

    • qRowScorenumber

      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

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

  • qNbrinteger

    Number of the current token definition.

    format = int32

  • qPNbrinteger

    Number of the parent rule definition.

    format = int32

  • qHelpIdinteger

    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

  • qNamestring

    Token name. One of:

    • A rule name
    • An identifier
    • A literal value
  • qStrstring

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

  • qIsBnfRuleboolean

    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

  • qScriptStatementboolean

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

    default = false

  • qControlStatementboolean

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

    default = false

  • qBnfLiteralboolean

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

    default = false

  • qQvFuncboolean

    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

  • qAggrFuncboolean

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

    default = false

  • qFGstring

    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"

  • qFieldFlagboolean

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

    default = false

  • qMTstring

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

  • qDeprboolean

    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

  • qFGListarray 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

  • qIdstring
  • qNamestring
  • qUtcModifyTimenumber

    format = double

  • qUtcRecallTimenumber

    format = double

  • qRecallCountinteger

    format = int32

  • qApplyAdditiveboolean
  • qFieldItemsarray of objects
    Show qFieldItems properties
    • qDefobject
      Show qDef properties
      • qNamestring

        Name of the field.

      • qTypestring

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

    • qLockedboolean

      Indicates if the field is locked. Default is false.

    • qSelectInfoobject
      Show qSelectInfo properties
      • qTextSearchstring

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

      • qRangeLonumber

        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

      • qRangeHinumber

        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

      • qNumberFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRangeInfoarray 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
        • qRangeLonumber

          Lowest value in the range.

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

        • qRangeHinumber

          Highest value in the range.

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

        • qMeasurestring

          Label of the measure.
      • qSoftLockboolean

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

        default = false

      • qContinuousRangeInfoarray of objects

        List of information about ranges for selections.

        Show qContinuousRangeInfo properties
        • qMinnumber

          Lowest value in the range

          format = double

        • qMaxnumber

          Highest value in the range

          format = double

        • qMinInclEqboolean

          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.

        • qMaxInclEqboolean

          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.
      • qSelectFieldSearchboolean

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

        default = false

    • qValuesarray of objects
      Show qValues properties
      • qTextstring

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

      • qIsNumericboolean

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

      • qNumbernumber

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

        format = double

    • qExcludedValuesarray of objects

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

      Show qExcludedValues properties
      • qTextstring

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

      • qIsNumericboolean

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

      • qNumbernumber

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

        format = double

    • qAndModeboolean

      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.

    • qOneAndOnlyOneboolean

      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.
  • qVariableItemsarray of objects
    Show qVariableItems properties
    • qNamestring

      Name of the variable.

    • qValueobject
      Show qValue properties
      • qTextstring

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

      • qIsNumericboolean

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

      • qNumbernumber

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

        format = double

    • qDefinitionstring

      The Reporting mode definition of the variable.
  • qSheetIdstring
  • qObjectsarray of objects
    Show qObjects properties
    • qIdstring
    • qActiveboolean
    • qShowModeinteger

      format = byte

    • qScrollPosobject
      Show qScrollPos properties
      • qUsePositionboolean
      • qPosobject
        Show qPos properties
        • qxinteger

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

          format = int32

        • qyinteger

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

          format = int32

  • qApplyLayoutStateboolean

    default = false

  • qShowPopupInfoboolean

    default = false

  • qInfoTextstring
  • qOwnerstring
  • qGroupsarray of objects
    Show qGroups properties
    • qIdstring
    • qCyclePosinteger

      format = int32

  • qShowobject
    Show qShow properties
    • qAlwaysboolean

      default = true

    • qExpressionobject
      Show qExpression properties
      • qvstring

        Expression evaluated to dual.
  • qApplyInputFieldValuesboolean

    default = true

  • qInputFieldItemsarray of objects
    Show qInputFieldItems properties
    • qFieldNamestring
    • qValuesarray of objects
      Show qValues properties
      • qTextstring

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

      • qIsNumericboolean

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

      • qNumbernumber

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

        format = double

    • qPackedHashKeysarray of integers
  • qObjectsLayoutarray of objects
    Show qObjectsLayout properties
    • qIdstring
    • qActiveboolean
    • qShowModeinteger

      format = byte

    • qScrollPosobject
      Show qScrollPos properties
      • qUsePositionboolean
      • qPosobject
        Show qPos properties
        • qxinteger

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

          format = int32

        • qyinteger

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

          format = int32

    • qExpansionInfoarray of objects
      Show qExpansionInfo properties
      • qExcludeListboolean
      • qPosobject
        Show qPos properties
        • qDimNamestring
        • qElemNoarray of integers
        • qElemValuesarray of strings
    • qLeftCollapsedboolean
    • qTopCollapsedboolean
    • qSortDataarray of objects
      Show qSortData properties
      • qNamestring
      • qReversedboolean
    • qDimensionGroupPosarray of objects
      Show qDimensionGroupPos properties
      • qGroupNamestring
      • qCurrentItemNamestring
    • qExpressionGroupPosarray of objects
      Show qExpressionGroupPos properties
      • qGroupNamestring
      • qCurrentItemNamestring
    • qUseGraphModeboolean
    • qGraphModestring

      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"

    • qActiveContainerChildObjectIdstring
    • qExtendedPivotStateobject
      Show qExtendedPivotState properties
      • qExpressionPositioninteger

        format = byte

      • qNumberOfLeftDimensionsinteger

        format = byte

      • qDimensionNamesarray of strings
      • qEnableConditionsarray of strings
  • qIncludeSelectionStateboolean

    default = true

  • qIncludeScrollPositionboolean
  • qAlternateStateDataarray of objects
    Show qAlternateStateData properties
    • qStateNamestring

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

    • qFieldItemsarray of objects

      List of the selections.

      Show qFieldItems properties
      • qDefobject
        Show qDef properties
        • qNamestring

          Name of the field.

        • qTypestring

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

      • qLockedboolean

        Indicates if the field is locked. Default is false.

      • qSelectInfoobject
        Show qSelectInfo properties
        • qTextSearchstring

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

        • qRangeLonumber

          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

        • qRangeHinumber

          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

        • qNumberFormatobject

          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
          • qTypestring

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

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

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

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRangeInfoarray 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
          • qRangeLonumber

            Lowest value in the range.

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

          • qRangeHinumber

            Highest value in the range.

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

          • qMeasurestring

            Label of the measure.
        • qSoftLockboolean

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

          default = false

        • qContinuousRangeInfoarray of objects

          List of information about ranges for selections.

          Show qContinuousRangeInfo properties
          • qMinnumber

            Lowest value in the range

            format = double

          • qMaxnumber

            Highest value in the range

            format = double

          • qMinInclEqboolean

            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.

          • qMaxInclEqboolean

            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.
        • qSelectFieldSearchboolean

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

          default = false

      • qValuesarray of objects
        Show qValues properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qExcludedValuesarray of objects

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

        Show qExcludedValues properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qAndModeboolean

        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.

      • qOneAndOnlyOneboolean

        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.
  • qForAnnotationsboolean
  • qIncludeAllVariablesboolean

    default = false

schemas BookmarkApplyAndVerifyResult object

Experimental

Properties

  • qApplySuccessboolean

    Apply successfully or not *

  • qWarningsarray of objects
    Experimental

    Field values verfication result *

    Show qWarnings properties
    • qStatestring

      Alternate State *

    • qFieldstring

      Field Name *

    • qVerifyResultstring

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

    • qMissingValuesarray of strings
  • qGroupStateResultobject
    Experimental

    Result of applying GroupState to multiple cyclic groups.

    Show qGroupStateResult properties
    • qApplySuccessboolean

      When true, the operation was successful.

    • qWarningsarray of objects
      Experimental

      Lists which states failed to be applied and why.

      Show qWarnings properties
      • qStateobject
        Experimental
        Show qState properties
        • qInfoobject
          Show qInfo properties
          • qIdstring

            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.

          • qTypestring

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

          String defining the active field.
      • qTypestring

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

schemas BookmarkFieldItem object

Properties

  • qDefobject
    Show qDef properties
    • qNamestring

      Name of the field.

    • qTypestring

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

  • qLockedboolean

    Indicates if the field is locked. Default is false.

  • qSelectInfoobject
    Show qSelectInfo properties
    • qTextSearchstring

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

    • qRangeLonumber

      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

    • qRangeHinumber

      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

    • qNumberFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qRangeInfoarray 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
      • qRangeLonumber

        Lowest value in the range.

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

      • qRangeHinumber

        Highest value in the range.

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

      • qMeasurestring

        Label of the measure.
    • qSoftLockboolean

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

      default = false

    • qContinuousRangeInfoarray of objects

      List of information about ranges for selections.

      Show qContinuousRangeInfo properties
      • qMinnumber

        Lowest value in the range

        format = double

      • qMaxnumber

        Highest value in the range

        format = double

      • qMinInclEqboolean

        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.

      • qMaxInclEqboolean

        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.
    • qSelectFieldSearchboolean

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

      default = false

  • qValuesarray of objects
    Show qValues properties
    • qTextstring

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

    • qIsNumericboolean

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

    • qNumbernumber

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

      format = double

  • qExcludedValuesarray of objects

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

    Show qExcludedValues properties
    • qTextstring

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

    • qIsNumericboolean

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

    • qNumbernumber

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

      format = double

  • qAndModeboolean

    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.

  • qOneAndOnlyOneboolean

    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.

schemas BookmarkFieldPage object

Defines the range of the bookmark fields that are returned.

Properties

  • qStartIndexinteger

    The start value of the range.

    format = int32

  • qEndIndexinteger

    The end value of the range.

    format = int32

schemas BookmarkFieldPageEx object

Properties

  • qStateNamestring

    The name of the selected state.

    default = "$"

  • qStartIndexinteger

    The start value of the range.

    default = 0, format = int32, default = 0

  • qEndIndexinteger

    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

schemas BookmarkFieldVerifyWarning object

Experimental

Properties

  • qStatestring

    Alternate State *

  • qFieldstring

    Field Name *

  • qVerifyResultstring

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

  • qMissingValuesarray of strings

schemas BookmarkList object

Lists the bookmarks. Is the layout for BookmarkListDef.

Properties

  • qItemsarray of objects

    Information about the list of bookmarks.

    Show qItems properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      Layout for NxMetaDef.

      Show qMeta properties
      • qNamestring

        Name. This property is optional.
    • qDataobject

      Contains dynamic JSON data specified by the client.

schemas BookmarkListDef object

Defines the list of bookmarks.

Properties

  • qTypestring

    Type of the list.

  • qDataobject

    Contains dynamic JSON data specified by the client.

  • qIncludePatchesboolean

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

schemas BookmarkStateFieldPages object

Properties

  • qStatePagesarray of objects

    Bookmark field pages for different states.

    Show qStatePages properties
    • qStateNamestring

      The name of the selected state.

      default = "$"

    • qStartIndexinteger

      The start value of the range.

      default = 0, format = int32, default = 0

    • qEndIndexinteger

      The end value of the range.

      default = 0, format = int32, default = 0

schemas BookmarkVariableItem object

Properties

  • qNamestring

    Name of the variable.

  • qValueobject
    Show qValue properties
    • qTextstring

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

    • qIsNumericboolean

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

    • qNumbernumber

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

      format = double

  • qDefinitionstring

    The Reporting mode definition of the variable.

schemas CalendarStrings object

Properties

  • qDayNamesarray of strings

    List of short day names.

  • qMonthNamesarray of strings

    List of short month names.

  • qLongDayNamesarray of strings

    List of long day names.

  • qLongMonthNamesarray of strings

    List of long month names.

schemas CharEncodingType string

oneOf

  • Utf8

    CHAR_ENCODING_UTF8

  • Utf16

    CHAR_ENCODING_UTF16

schemas CharRange object

Properties

  • qCharPosinteger

    Position of the first search occurrence.

    format = int32

  • qCharCountinteger

    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

  • qItemsarray of objects

    Information about the items in the app object.

    Show qItems properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      Layout for NxMetaDef.

      Show qMeta properties
      • qNamestring

        Name. This property is optional.
    • qDataobject

      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

  • qDataobject

    Contains dynamic JSON data specified by the client.

schemas CodePage object

Properties

  • qNumberinteger

    Number of the code page.

    format = int32

  • qNamestring

    Name of the code page.

  • qDescriptionstring

    Description of the code page.

schemas CondDef object

Properties

  • qAlwaysboolean

    default = true

  • qExpressionobject
    Show qExpression properties
    • qvstring

      Expression evaluated to dual.

schemas Connection object

Properties

  • qIdstring

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

  • qNamestring

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

  • qConnectionStringstring

    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.

  • qTypestring

    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.

  • qUserNamestring

    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.

  • qPasswordstring

    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.

  • qModifiedDatestring

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

  • qMetaobject

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qLogOnstring

    Can be one of: "LOG_ON_SERVICE_USER""LOG_ON_CURRENT_USER"

schemas ContentLibraryList object

Properties

  • qItemsarray of objects

    Information about the content library.

    Show qItems properties
    • qNamestring

      Name of the library.

    • qAppSpecificboolean

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

    • qMetaobject

      Layout for NxMetaDef.

      Show qMeta properties
      • qNamestring

        Name. This property is optional.

schemas ContentLibraryListItem object

Properties

  • qNamestring

    Name of the library.

  • qAppSpecificboolean

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

  • qMetaobject

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.

schemas CustomConnector object

Properties

  • qProviderstring

    Name of the custom connector file.

  • qParentstring

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

  • qDisplayNamestring

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

  • qMachineModestring

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

  • qSupportFileStreamingboolean

schemas CyclicGroupPosition object

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

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

    format = int32

schemas DataField object

Properties

  • qNamestring

    Name of the field.

  • qIsKeyboolean

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

    default = false

  • qOriginalFieldNamestring

    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

  • qValuesarray 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

  • qNamestring

    Name of the table.

  • qTypestring

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

schemas DataTableEx object

Properties

  • qNamestring

    Name of the table.

  • qFieldsarray of objects

    List of the fields in the table.

    Show qFields properties
    • qNamestring

      Name of the field.

    • qIsKeyboolean

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

      default = false

    • qOriginalFieldNamestring

      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.
  • qFormatSpecstring

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

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

schemas Database object

Properties

  • qNamestring

    Name of the database.

  • qIsDefaultboolean

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

schemas DatabaseInfo object

Properties

  • qDBMSNamestring

    Name of the product accessed by the provider.

  • qDBUsageboolean

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

  • qOwnerUsageboolean

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

  • qDBSeparatorstring

    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
  • qOwnerSeparatorstring

    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
  • qDBFirstboolean

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

  • qQuotePreffixstring

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

  • qQuoteSuffixstring

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

  • qSpecialCharsstring

    List of the special characters.

  • qDefaultDatabasestring

    Name of the default database.

  • qKeywordsarray of strings

    List of the script keywords.

schemas DatabaseOwner object

Properties

  • qNamestring

    Name of the owner.

schemas DelimiterInfo object

Properties

  • qNamestring

    Name of the delimiter. Example: "Tab_DELIMITER"

  • qScriptCodestring

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

  • qNumberinteger

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

    format = int32

  • qIsMultipleboolean

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

schemas DerivedFieldsInTableData object

Properties

  • qDefinitionNamestring

    Name of the derived definition.

  • qTagsarray of strings

    List of tags.

  • qActiveboolean

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

schemas DimensionList object

Lists the dimensions. Is the layout for DimensionListDef.

Properties

  • qItemsarray of objects

    Information about the list of dimensions.

    Show qItems properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      Layout for NxMetaDef.

      Show qMeta properties
      • qNamestring

        Name. This property is optional.
    • qDataobject

      Contains dynamic JSON data specified by the client.

schemas DimensionListDef object

Defines the lists of dimensions.

Properties

  • qTypestring

    Type of the list.

  • qDataobject

    Contains dynamic JSON data specified by the client.

schemas DimensionReference object

Experimental

The DimensionReference structure points to a GenericDimension.

Properties

  • qIdstring

    Identifier of the associated dimension.

  • qLabelstring

    Text label.

schemas DoReloadExParams object

Parameters for a reload.

Properties

  • qModeinteger
    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

  • qPartialboolean

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

    default = false

  • qDebugboolean

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

    default = false

  • qReloadIdstring

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

  • qSkipStoreboolean

    Set to true to skip Store statements. The default value is false.

    default = false

  • qRowLimitinteger

    If greater than or equal 0, defines max 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

  • qSuccessboolean

    The reload is successful if True.

  • qScriptLogFilestring

    Path to the script log file.

  • qEndedWithMemoryConstraintboolean

    true if memory limits were exhausted during reload.

schemas DocListEntry object

Properties

  • qDocNamestring

    Name of the app.

  • qConnectedUsersinteger

    Not used.

    format = int32

  • qFileTimenumber

    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

  • qFileSizenumber

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

    format = double

  • qDocIdstring

    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.
  • qMetaobject

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qLastReloadTimestring

    Last reload time of the app.

  • qReadOnlyboolean

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

  • qTitlestring

    Title of the app.

  • qThumbnailobject
    In addition, this structure can return dynamic properties.
    Show qThumbnail properties
    • qUrlstring

      Relative path of the thumbnail.
  • qHasSectionAccessboolean

    If true the app has section access configured.

  • qIsDirectQueryModeboolean

    Is the app a Direct Query app?

  • qUsagestring

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

schemas DriveInfo object

Properties

  • qDrivestring

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

  • qTypestring

    Type of the drive. Fixed means physical drive.

  • qNamestring

    Name of the drive.

  • qTypeIdentifierstring

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

  • qUnnamedDriveboolean

schemas DriveType string

oneOf

  • REMOVABLE

  • FIXED

  • NETWORK

  • CD_ROM

  • RAM

  • UNKNOWN_TYPE

schemas EditorBreakpoint object

Properties

  • qbufferNamestring

    Name of the breakpoint.

  • qlineIxinteger

    Line number in the script where the breakpoint is set.

    format = int32

  • qEnabledboolean

    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

  • qErrorStringstring

    Detailed information about the error message.

  • qLineEndstring

    Line termination characters.

  • qLinestring

    Script statement where the error occurs.

  • qErrorDataCodestring

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

  • qMessageobject
    Show qMessage properties
    • qMessageCodeinteger

      Code number to the corresponding localized message string.

      format = int32

    • qMessageParametersarray 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

  • qExcludeListboolean
  • qPosobject
    Show qPos properties
    • qDimNamestring
    • qElemNoarray of integers
    • qElemValuesarray of strings

schemas ExtendedLayoutBookmarkData object

Properties

  • qIdstring
  • qActiveboolean
  • qShowModeinteger

    format = byte

  • qScrollPosobject
    Show qScrollPos properties
    • qUsePositionboolean
    • qPosobject
      Show qPos properties
      • qxinteger

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

        format = int32

      • qyinteger

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

        format = int32

  • qExpansionInfoarray of objects
    Show qExpansionInfo properties
    • qExcludeListboolean
    • qPosobject
      Show qPos properties
      • qDimNamestring
      • qElemNoarray of integers
      • qElemValuesarray of strings
  • qLeftCollapsedboolean
  • qTopCollapsedboolean
  • qSortDataarray of objects
    Show qSortData properties
    • qNamestring
    • qReversedboolean
  • qDimensionGroupPosarray of objects
    Show qDimensionGroupPos properties
    • qGroupNamestring
    • qCurrentItemNamestring
  • qExpressionGroupPosarray of objects
    Show qExpressionGroupPos properties
    • qGroupNamestring
    • qCurrentItemNamestring
  • qUseGraphModeboolean
  • qGraphModestring

    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"

  • qActiveContainerChildObjectIdstring
  • qExtendedPivotStateobject
    Show qExtendedPivotState properties
    • qExpressionPositioninteger

      format = byte

    • qNumberOfLeftDimensionsinteger

      format = byte

    • qDimensionNamesarray of strings
    • qEnableConditionsarray of strings

schemas ExtendedPivotStateData object

Properties

  • qExpressionPositioninteger

    format = byte

  • qNumberOfLeftDimensionsinteger

    format = byte

  • qDimensionNamesarray of strings
  • qEnableConditionsarray of strings

schemas ExtensionList object

Obsolete, use qrs API's to fetch extensions.

Properties

  • qItemsarray of strings

schemas ExtensionListDef object

Obsolete, use qrs API's to fetch extensions.

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

  • qTypestring

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

  • qnDecinteger

    Number of decimals. Default is 10.

    default = 10, format = int32, default = 10

  • qUseThouinteger

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

    default = 0, format = int32, default = 0

  • qFmtstring

    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.

  • qDecstring

    Defines the decimal separator. Example: .

  • qThoustring

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

schemas FieldDefEx object

Properties

  • qNamestring

    Name of the field.

  • qTypestring

    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

  • qInternalNumberinteger

    Internal number of the field.

    format = int32

  • qNamestring

    Name of the field.

  • qSrcTablesarray of strings

    List of table names.

  • qIsSystemboolean

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

  • qIsHiddenboolean

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

  • qIsSemanticboolean

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

  • qDistinctOnlyboolean

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

  • qCardinalinteger

    Number of distinct field values.

    format = int32

  • qTotalCountinteger

    Total number of field values.

    format = int64

  • qPossibleCount_OBSOLETEinteger

    format = int32

  • qHasInfo_OBSOLETEboolean
  • qIsLockedboolean

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

  • qAlwaysOneSelectedboolean

    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.

  • qAndModeboolean

    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.

  • qIsNumericboolean

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

  • qCommentstring

    Field comment.

  • qTagsarray of strings

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

  • qIsDefinitionOnlyboolean

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

  • qByteSizeinteger

    Static RAM memory used in bytes.

    format = int64

schemas FieldInTableData object

Properties

  • qNamestring

    Name of the field.

  • qOriginalFieldsarray 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.

  • qPresentboolean
  • qHasNullboolean

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

  • qHasWildboolean
  • qHasDuplicatesboolean

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

  • qIsSyntheticboolean

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

  • qInformationDensitynumber

    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

  • qnNonNullsinteger

    Number of values that are non Null.

    format = int64

  • qnRowsinteger

    Number of rows in the field.

    format = int64

  • qSubsetRationumber

    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

  • qnTotalDistinctValuesinteger

    Number of distinct values in the field.

    format = int32

  • qnPresentDistinctValuesinteger

    format = int32

  • qKeyTypestring

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

  • qCommentstring

    Comment related to the field.

  • qTagsarray of strings

    List of tags related to the field.

  • qDerivedFieldsarray of objects

    List of the derived fields.

    Show qDerivedFields properties
    • qDefinitionNamestring

      Name of the derived definition.

    • qTagsarray of strings

      List of tags.

    • qActiveboolean

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

    default = false

  • qReadableNamestring

schemas FieldInTableProfilingData object

Properties

  • qNamestring

    Name of the field.

  • qFieldTagsarray of strings

    List of tags related to the field.

  • qNumberFormatobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

    Number of distinct values

    format = int64

  • qDistinctNumericValuesinteger

    Number of distinct numeric values

    format = int64

  • qDistinctTextValuesinteger

    Number of distinct text values

    format = int64

  • qNumericValuesinteger

    Number of numeric values

    format = int64

  • qNullValuesinteger

    Number of null values

    format = int64

  • qTextValuesinteger

    Number of textual values

    format = int64

  • qNegValuesinteger

    Number of negative values

    format = int64

  • qPosValuesinteger

    Number of positive values

    format = int64

  • qZeroValuesinteger

    Number of zero values for numerical values

    format = int64

  • qSumnumber

    Sum of all numerical values. NaN otherwise.

    format = double

  • qSum2number

    Squared sum of all numerical values. NaN otherwise.

    format = double

  • qAveragenumber

    Average of all numerical values. NaN otherwise.

    format = double

  • qMediannumber

    Median of all numerical values. NaN otherwise.

    format = double

  • qStdnumber

    Standard deviation of numerical values. NaN otherwise.

    format = double

  • qMinnumber

    Minimum value of numerical values. NaN otherwise.

    format = double

  • qMaxnumber

    Maximum value of numerical values. NaN otherwise.

    format = double

  • qSkewnessnumber

    Skewness of the numerical values. NaN otherwise.

    format = double

  • qKurtosisnumber

    Kurtosis of the numerical values. NaN otherwise.

    format = double

  • qFractilesarray of numbers

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

  • qEmptyStringsinteger

    Number of empty strings

    format = int64

  • qMaxStringLeninteger

    Maximum string length of textual values. 0 otherwise.

    format = int64

  • qMinStringLeninteger

    Minimum string length of textual values. 0 otherwise.

    format = int64

  • qSumStringLeninteger

    Sum of all characters in strings in the field

    format = int64

  • qAvgStringLennumber

    Average string length of textual values. 0 otherwise.

    format = double

  • qFirstSortedstring

    For textual values the first sorted string.

  • qLastSortedstring

    For textual values the last sorted string.

  • qMostFrequentarray of objects

    Three most frequent values and their frequencies

    Show qMostFrequent properties
    • qSymbolobject
      Show qSymbol properties
      • qTextstring

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

      • qNumbernumber

        Numeric value of the symbol. NaN otherwise.

        format = double

    • qFrequencyinteger

      Frequency of the above symbol in the field

      format = int64

  • qFrequencyDistributionobject
    Show qFrequencyDistribution properties
    • qNumberOfBinsinteger

      Number of bins.

      format = int32

    • qBinsEdgesarray of numbers

      Bins edges.

    • qFrequenciesarray of integers

      Bins frequencies.

schemas FieldList object

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

Properties

  • qItemsarray of objects

    Array of items.

    Show qItems properties
    • qIsSemanticboolean

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

    • qIsHiddenboolean

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

    • qIsSystemboolean

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

    • qAndModeboolean

      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.

    • qNamestring

      Name of the field

    • qCardinalinteger

      Number of distinct field values

      format = int32

    • qTagsarray of strings

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

    • qIsDefinitionOnlyboolean

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

    • qDerivedFieldDataobject
      Show qDerivedFieldData properties
      • qDerivedFieldListsarray of objects

        Information about the derived fields.

        Show qDerivedFieldLists properties
        • qDerivedDefinitionNamestring

          Name of the derived definition.

        • qFieldDefsarray of objects

          List of the derived fields.

          Show qFieldDefs properties
          • qIdstring

            Identifier of the derived field. The identifier is unique.

          • qNamestring

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

          • qMethodstring

            Method name associated to the derived field.

          • qExprstring

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

          • qTagsarray of strings

            List of tags.
        • qGroupDefsarray of objects

          List of the derived groups.

          Show qGroupDefs properties
          • qIdstring

            Identifier of the group.

          • qNamestring

            Name of the derived group.

          • qGroupingstring

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

          • qFieldDefsarray of strings

            List of the derived fields in the group.
        • qTagsarray of strings

          List of tags on the derived fields.
    • qIsDetailboolean

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

    • qIsImplicitboolean

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

    • qReadableNamestring

schemas FieldListDef object

Defines the fields to show.

Properties

  • qShowSystemboolean

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

    default = false

  • qShowHiddenboolean

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

    default = false

  • qShowSemanticboolean

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

    default = false

  • qShowSrcTablesboolean

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

    default = false

  • qShowDefinitionOnlyboolean

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

    default = false

  • qShowDerivedFieldsboolean

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

    default = false

  • qShowImplicitboolean

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

    default = false

schemas FieldOrColumn object

Properties

  • qFieldNamestring

    Name of the field or column to be matched.

  • qTableNamestring

    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

  • qFieldNamestring

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

  • qReadableNamestring
  • qCardinalRationumber

    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

  • qSymbolScorenumber

    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

  • qRowScorenumber

    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

  • qTextstring

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

  • qIsNumericboolean

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

  • qNumbernumber

    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

Properties

  • qTypestring

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

  • qLabelstring

    One of:

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

    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.

  • qCommentstring

    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.

  • qDelimiterobject
    Show qDelimiter properties
    • qNamestring

      Name of the delimiter. Example: "Tab_DELIMITER"

    • qScriptCodestring

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

    • qNumberinteger

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

      format = int32

    • qIsMultipleboolean

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

    Character set used in the file.

    format = int32

  • qHeaderSizeinteger

    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

  • qRecordSizeinteger

    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

  • qTabSizeinteger

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

    format = int32

  • qIgnoreEOFboolean

    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.

  • qFixedWidthDelimitersstring

    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

schemas FilterInfo object

Properties

  • qTypestring

    Can be one of: "NONE""RAW"

  • qWherePredicatestring

schemas FilterType string

oneOf

  • NONE

    FILTER_TYPE_NONE

  • RAW

    FILTER_TYPE_RAW

schemas FolderItem object

Properties

  • qNamestring

    Name of the folder item.

  • qTypestring

    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

  • qNumberOfBinsinteger

    Number of bins.

    format = int32

  • qBinsEdgesarray of numbers

    Bins edges.

  • qFrequenciesarray of integers

    Bins frequencies.

schemas Function object

Properties

  • qNamestring

    Name of the script function.

  • qGroupstring

    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"

  • qSignaturestring

    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

  • qPropertiesobject
    Show qProperties properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

    • qIncludeVariablesboolean
      Experimental

      If true all variables will be stored in the bookmark.

      default = false

    • qDistinctValuesboolean
      Experimental

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

      default = false

  • qBookmarkobject
    Show qBookmark properties
    • qStateDataarray of objects

      List of selections for each state.

      Show qStateData properties
      • qStateNamestring

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

      • qFieldItemsarray of objects

        List of the selections.

        Show qFieldItems properties
        • qDefobject
          Show qDef properties
          • qNamestring

            Name of the field.

          • qTypestring

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

        • qLockedboolean

          Indicates if the field is locked. Default is false.

        • qSelectInfoobject
          Show qSelectInfo properties
          • qTextSearchstring

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

          • qRangeLonumber

            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

          • qRangeHinumber

            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

          • qNumberFormatobject

            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
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

              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.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRangeInfoarray 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
            • qRangeLonumber

              Lowest value in the range.

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

            • qRangeHinumber

              Highest value in the range.

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

            • qMeasurestring

              Label of the measure.
          • qSoftLockboolean

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

            default = false

          • qContinuousRangeInfoarray of objects

            List of information about ranges for selections.

            Show qContinuousRangeInfo properties
            • qMinnumber

              Lowest value in the range

              format = double

            • qMaxnumber

              Highest value in the range

              format = double

            • qMinInclEqboolean

              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.

            • qMaxInclEqboolean

              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.
          • qSelectFieldSearchboolean

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

            default = false

        • qValuesarray of objects
          Show qValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qExcludedValuesarray of objects

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

          Show qExcludedValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qAndModeboolean

          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.

        • qOneAndOnlyOneboolean

          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.
    • qUtcModifyTimenumber

      Time when the bookmark was created.

      format = double

    • qVariableItemsarray of objects

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

      Show qVariableItems properties
      • qNamestring

        Name of the variable.

      • qValueobject
        Show qValue properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qDefinitionstring

        The Reporting mode definition of the variable.
    • qPatchesarray of objects

      Softpatches to be applied with this bookmark.

      Show qPatches properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

          Type of the object. This parameter is mandatory.
      • qPatchesarray of objects

        Array with patches.

        Show qPatches properties
        • qOpstring

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

        • qPathstring

          Path to the property to add, remove or replace.

        • qValuestring

          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""
      • qChildrenarray of undefineds

        Array with child objects and their patches.
    • qCyclicGroupStatesarray of objects

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

      Show qCyclicGroupStates properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

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

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

        format = int32

    • qGroupStatesarray of objects
      Experimental

      Information about cyclic groups indexed by field definition.

      Show qGroupStates properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

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

        String defining the active field.
  • qClassicBookmarkobject
    Show qClassicBookmark properties
    • qIdstring
    • qNamestring
    • qUtcModifyTimenumber

      format = double

    • qUtcRecallTimenumber

      format = double

    • qRecallCountinteger

      format = int32

    • qApplyAdditiveboolean
    • qFieldItemsarray of objects
      Show qFieldItems properties
      • qDefobject
        Show qDef properties
        • qNamestring

          Name of the field.

        • qTypestring

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

      • qLockedboolean

        Indicates if the field is locked. Default is false.

      • qSelectInfoobject
        Show qSelectInfo properties
        • qTextSearchstring

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

        • qRangeLonumber

          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

        • qRangeHinumber

          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

        • qNumberFormatobject

          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
          • qTypestring

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

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

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

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRangeInfoarray 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
          • qRangeLonumber

            Lowest value in the range.

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

          • qRangeHinumber

            Highest value in the range.

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

          • qMeasurestring

            Label of the measure.
        • qSoftLockboolean

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

          default = false

        • qContinuousRangeInfoarray of objects

          List of information about ranges for selections.

          Show qContinuousRangeInfo properties
          • qMinnumber

            Lowest value in the range

            format = double

          • qMaxnumber

            Highest value in the range

            format = double

          • qMinInclEqboolean

            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.

          • qMaxInclEqboolean

            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.
        • qSelectFieldSearchboolean

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

          default = false

      • qValuesarray of objects
        Show qValues properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qExcludedValuesarray of objects

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

        Show qExcludedValues properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qAndModeboolean

        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.

      • qOneAndOnlyOneboolean

        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.
    • qVariableItemsarray of objects
      Show qVariableItems properties
      • qNamestring

        Name of the variable.

      • qValueobject
        Show qValue properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qDefinitionstring

        The Reporting mode definition of the variable.
    • qSheetIdstring
    • qObjectsarray of objects
      Show qObjects properties
      • qIdstring
      • qActiveboolean
      • qShowModeinteger

        format = byte

      • qScrollPosobject
        Show qScrollPos properties
        • qUsePositionboolean
        • qPosobject
          Show qPos properties
          • qxinteger

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

            format = int32

          • qyinteger

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

            format = int32

    • qApplyLayoutStateboolean

      default = false

    • qShowPopupInfoboolean

      default = false

    • qInfoTextstring
    • qOwnerstring
    • qGroupsarray of objects
      Show qGroups properties
      • qIdstring
      • qCyclePosinteger

        format = int32

    • qShowobject
      Show qShow properties
      • qAlwaysboolean

        default = true

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
    • qApplyInputFieldValuesboolean

      default = true

    • qInputFieldItemsarray of objects
      Show qInputFieldItems properties
      • qFieldNamestring
      • qValuesarray of objects
        Show qValues properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qPackedHashKeysarray of integers
    • qObjectsLayoutarray of objects
      Show qObjectsLayout properties
      • qIdstring
      • qActiveboolean
      • qShowModeinteger

        format = byte

      • qScrollPosobject
        Show qScrollPos properties
        • qUsePositionboolean
        • qPosobject
          Show qPos properties
          • qxinteger

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

            format = int32

          • qyinteger

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

            format = int32

      • qExpansionInfoarray of objects
        Show qExpansionInfo properties
        • qExcludeListboolean
        • qPosobject
          Show qPos properties
          • qDimNamestring
          • qElemNoarray of integers
          • qElemValuesarray of strings
      • qLeftCollapsedboolean
      • qTopCollapsedboolean
      • qSortDataarray of objects
        Show qSortData properties
        • qNamestring
        • qReversedboolean
      • qDimensionGroupPosarray of objects
        Show qDimensionGroupPos properties
        • qGroupNamestring
        • qCurrentItemNamestring
      • qExpressionGroupPosarray of objects
        Show qExpressionGroupPos properties
        • qGroupNamestring
        • qCurrentItemNamestring
      • qUseGraphModeboolean
      • qGraphModestring

        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"

      • qActiveContainerChildObjectIdstring
      • qExtendedPivotStateobject
        Show qExtendedPivotState properties
        • qExpressionPositioninteger

          format = byte

        • qNumberOfLeftDimensionsinteger

          format = byte

        • qDimensionNamesarray of strings
        • qEnableConditionsarray of strings
    • qIncludeSelectionStateboolean

      default = true

    • qIncludeScrollPositionboolean
    • qAlternateStateDataarray of objects
      Show qAlternateStateData properties
      • qStateNamestring

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

      • qFieldItemsarray of objects

        List of the selections.

        Show qFieldItems properties
        • qDefobject
          Show qDef properties
          • qNamestring

            Name of the field.

          • qTypestring

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

        • qLockedboolean

          Indicates if the field is locked. Default is false.

        • qSelectInfoobject
          Show qSelectInfo properties
          • qTextSearchstring

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

          • qRangeLonumber

            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

          • qRangeHinumber

            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

          • qNumberFormatobject

            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
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

              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.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRangeInfoarray 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
            • qRangeLonumber

              Lowest value in the range.

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

            • qRangeHinumber

              Highest value in the range.

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

            • qMeasurestring

              Label of the measure.
          • qSoftLockboolean

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

            default = false

          • qContinuousRangeInfoarray of objects

            List of information about ranges for selections.

            Show qContinuousRangeInfo properties
            • qMinnumber

              Lowest value in the range

              format = double

            • qMaxnumber

              Highest value in the range

              format = double

            • qMinInclEqboolean

              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.

            • qMaxInclEqboolean

              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.
          • qSelectFieldSearchboolean

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

            default = false

        • qValuesarray of objects
          Show qValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qExcludedValuesarray of objects

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

          Show qExcludedValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qAndModeboolean

          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.

        • qOneAndOnlyOneboolean

          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.
    • qForAnnotationsboolean
    • qIncludeAllVariablesboolean

      default = false

  • qClassicMetadataobject
    Show qClassicMetadata properties
    • qSharedboolean
    • qUtcModifyTimenumber

      format = double

    • qSheetIdstring
    • qTemporaryboolean
    • qRestrictedAccessboolean
    • qAccessListarray of strings
    • qPersonalEditionHash_OBSOLETEstring
    • qHiddenboolean

      default = false

    • qLinkedToarray of strings

schemas GenericBookmarkLayout object

Is the layout for GenericBookmarkProperties.

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qBookmarkobject
    Show qBookmark properties
    • qStateDataarray of objects

      List of selections for each state.

      Show qStateData properties
      • qStateNamestring

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

      • qFieldItemsarray of objects

        List of the selections.

        Show qFieldItems properties
        • qDefobject
          Show qDef properties
          • qNamestring

            Name of the field.

          • qTypestring

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

        • qLockedboolean

          Indicates if the field is locked. Default is false.

        • qSelectInfoobject
          Show qSelectInfo properties
          • qTextSearchstring

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

          • qRangeLonumber

            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

          • qRangeHinumber

            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

          • qNumberFormatobject

            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
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

              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.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRangeInfoarray 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
            • qRangeLonumber

              Lowest value in the range.

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

            • qRangeHinumber

              Highest value in the range.

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

            • qMeasurestring

              Label of the measure.
          • qSoftLockboolean

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

            default = false

          • qContinuousRangeInfoarray of objects

            List of information about ranges for selections.

            Show qContinuousRangeInfo properties
            • qMinnumber

              Lowest value in the range

              format = double

            • qMaxnumber

              Highest value in the range

              format = double

            • qMinInclEqboolean

              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.

            • qMaxInclEqboolean

              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.
          • qSelectFieldSearchboolean

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

            default = false

        • qValuesarray of objects
          Show qValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qExcludedValuesarray of objects

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

          Show qExcludedValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qAndModeboolean

          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.

        • qOneAndOnlyOneboolean

          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.
    • qUtcModifyTimenumber

      Time when the bookmark was created.

      format = double

    • qVariableItemsarray of objects

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

      Show qVariableItems properties
      • qNamestring

        Name of the variable.

      • qValueobject
        Show qValue properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qDefinitionstring

        The Reporting mode definition of the variable.
    • qPatchesarray of objects

      Softpatches to be applied with this bookmark.

      Show qPatches properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

          Type of the object. This parameter is mandatory.
      • qPatchesarray of objects

        Array with patches.

        Show qPatches properties
        • qOpstring

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

        • qPathstring

          Path to the property to add, remove or replace.

        • qValuestring

          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""
      • qChildrenarray of undefineds

        Array with child objects and their patches.
    • qCyclicGroupStatesarray of objects

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

      Show qCyclicGroupStates properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

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

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

        format = int32

    • qGroupStatesarray of objects
      Experimental

      Information about cyclic groups indexed by field definition.

      Show qGroupStates properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

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

        String defining the active field.
  • qFieldInfosarray of objects

    Information about the field selections associated with the bookmark.

    Show qFieldInfos properties
    • qFieldNamestring

      The name of the field.

    • qValuesCountinteger

      Number of selected values in the field.

      format = int32

    • qExcludedValuesCountinteger

      Number of excluded values in the field.

      format = int32

schemas GenericBookmarkProperties object

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    Used to collect meta data.

    Properties

    Semantic type with an empty structure.

  • qIncludeVariablesboolean
    Experimental

    If true all variables will be stored in the bookmark.

    default = false

  • qDistinctValuesboolean
    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

  • qApprMaxGlyphCountinteger

    Length of the longest value in the field.

    format = int32

  • qCardinalinteger

    Number of distinct field values

    format = int32

  • qTagsarray of strings

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

  • qIsSemanticboolean

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

  • qAndModeboolean

    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

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qDimobject
    Show qDim properties
    • qGroupingstring

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

    • qFieldDefsarray of strings

      Array of dimension names.

    • qFieldLabelsarray of strings

      Array of dimension labels.

    • qLabelExpressionstring
    • qAliasstring

      Alias of the dimension.
  • qDimInfosarray of objects

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

    Show qDimInfos properties
    • qApprMaxGlyphCountinteger

      Length of the longest value in the field.

      format = int32

    • qCardinalinteger

      Number of distinct field values

      format = int32

    • qTagsarray of strings

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

    • qIsSemanticboolean

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

    • qAndModeboolean

      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

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

      Type of the object. This parameter is mandatory.
  • qDimobject
    Show qDim properties
    • qGroupingstring

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

    • qFieldDefsarray of strings

      Array of dimension names.

    • qFieldLabelsarray of strings

      Array of dimension labels.

    • qLabelExpressionstring
    • qAliasstring

      Alias of the dimension.
  • qMetaDefobject

    Used to collect meta data.

    Properties

    Semantic type with an empty structure.

schemas GenericMeasureLayout object

Is the layout for GenericMeasureProperties.

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

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

    Show qMeasure properties
    • qLabelstring
    • qDefstring
    • qGroupingstring

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

    • qExpressionsarray of strings
    • qActiveExpressioninteger

      format = int32

    • qLabelExpressionstring
    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.

schemas GenericMeasureProperties object

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

      Type of the object. This parameter is mandatory.
  • qMeasureobject
    Show qMeasure properties
    • qLabelstring

      Label of the measure.

    • qDefstring

      Definition of the measure.

    • qGroupingstring

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

    • qExpressionsarray of strings

      Array of expressions.

    • qActiveExpressioninteger

      Index to the active expression in a measure.

      format = int32

    • qLabelExpressionstring

      Optional expression used for dynamic label.

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

    Used to collect meta data.

    Properties

    Semantic type with an empty structure.

schemas GenericObjectEntry object

Properties

  • qPropertyobject

    additional properties

    Show qProperty properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      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.

    • qMetaDefobject

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

    • qStateNamestring

      Name of the alternate state. Default is current selections $ .
  • qChildrenarray of objects

    Information about the children of the generic object.

    Show qChildren properties
    • qPropertyobject

      additional properties

      Show qProperty properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

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

        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.

      • qMetaDefobject

        Used to collect meta data.

        Properties

        Semantic type with an empty structure.

      • qStateNamestring

        Name of the alternate state. Default is current selections $ .
    • qChildrenarray of undefineds

      Information about the children of the generic object.

    • qEmbeddedSnapshotRefobject
      Show qEmbeddedSnapshotRef properties
      • qPropertiesobject
        Show qProperties properties
        • qInfoobject
          Show qInfo properties
          • qIdstring

            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.

          • qTypestring

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

          Used to collect meta data.

          Properties

          Semantic type with an empty structure.

        • qIncludeVariablesboolean
          Experimental

          If true all variables will be stored in the bookmark.

          default = false

        • qDistinctValuesboolean
          Experimental

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

          default = false

      • qBookmarkobject
        Show qBookmark properties
        • qStateDataarray of objects

          List of selections for each state.

          Show qStateData properties
          • qStateNamestring

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

          • qFieldItemsarray of objects

            List of the selections.

            Show qFieldItems properties
            • qDefobject
              Show qDef properties
              • qNamestring

                Name of the field.

              • qTypestring

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

            • qLockedboolean

              Indicates if the field is locked. Default is false.

            • qSelectInfoobject
              Show qSelectInfo properties
              • qTextSearchstring

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

              • qRangeLonumber

                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

              • qRangeHinumber

                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

              • qNumberFormatobject

                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
                • qTypestring

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

                • qnDecinteger

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThouinteger

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

                  default = 0, format = int32, default = 0

                • qFmtstring

                  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.

                • qDecstring

                  Defines the decimal separator. Example: .

                • qThoustring

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRangeInfoarray 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
                • qRangeLonumber

                  Lowest value in the range.

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

                • qRangeHinumber

                  Highest value in the range.

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

                • qMeasurestring

                  Label of the measure.
              • qSoftLockboolean

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

                default = false

              • qContinuousRangeInfoarray of objects

                List of information about ranges for selections.

                Show qContinuousRangeInfo properties
                • qMinnumber

                  Lowest value in the range

                  format = double

                • qMaxnumber

                  Highest value in the range

                  format = double

                • qMinInclEqboolean

                  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.

                • qMaxInclEqboolean

                  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.
              • qSelectFieldSearchboolean

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

                default = false

            • qValuesarray of objects
              Show qValues properties
              • qTextstring

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

              • qIsNumericboolean

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

              • qNumbernumber

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

                format = double

            • qExcludedValuesarray of objects

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

              Show qExcludedValues properties
              • qTextstring

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

              • qIsNumericboolean

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

              • qNumbernumber

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

                format = double

            • qAndModeboolean

              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.

            • qOneAndOnlyOneboolean

              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.
        • qUtcModifyTimenumber

          Time when the bookmark was created.

          format = double

        • qVariableItemsarray of objects

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

          Show qVariableItems properties
          • qNamestring

            Name of the variable.

          • qValueobject
            Show qValue properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qDefinitionstring

            The Reporting mode definition of the variable.
        • qPatchesarray of objects

          Softpatches to be applied with this bookmark.

          Show qPatches properties
          • qInfoobject
            Show qInfo properties
            • qIdstring

              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.

            • qTypestring

              Type of the object. This parameter is mandatory.
          • qPatchesarray of objects

            Array with patches.

            Show qPatches properties
            • qOpstring

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

            • qPathstring

              Path to the property to add, remove or replace.

            • qValuestring

              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""
          • qChildrenarray of undefineds

            Array with child objects and their patches.
        • qCyclicGroupStatesarray of objects

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

          Show qCyclicGroupStates properties
          • qInfoobject
            Show qInfo properties
            • qIdstring

              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.

            • qTypestring

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

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

            format = int32

        • qGroupStatesarray of objects
          Experimental

          Information about cyclic groups indexed by field definition.

          Show qGroupStates properties
          • qInfoobject
            Show qInfo properties
            • qIdstring

              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.

            • qTypestring

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

            String defining the active field.
      • qClassicBookmarkobject
        Show qClassicBookmark properties
        • qIdstring
        • qNamestring
        • qUtcModifyTimenumber

          format = double

        • qUtcRecallTimenumber

          format = double

        • qRecallCountinteger

          format = int32

        • qApplyAdditiveboolean
        • qFieldItemsarray of objects
          Show qFieldItems properties
          • qDefobject
            Show qDef properties
            • qNamestring

              Name of the field.

            • qTypestring

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

          • qLockedboolean

            Indicates if the field is locked. Default is false.

          • qSelectInfoobject
            Show qSelectInfo properties
            • qTextSearchstring

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

            • qRangeLonumber

              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

            • qRangeHinumber

              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

            • qNumberFormatobject

              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
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

                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.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRangeInfoarray 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
              • qRangeLonumber

                Lowest value in the range.

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

              • qRangeHinumber

                Highest value in the range.

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

              • qMeasurestring

                Label of the measure.
            • qSoftLockboolean

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

              default = false

            • qContinuousRangeInfoarray of objects

              List of information about ranges for selections.

              Show qContinuousRangeInfo properties
              • qMinnumber

                Lowest value in the range

                format = double

              • qMaxnumber

                Highest value in the range

                format = double

              • qMinInclEqboolean

                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.

              • qMaxInclEqboolean

                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.
            • qSelectFieldSearchboolean

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

              default = false

          • qValuesarray of objects
            Show qValues properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qExcludedValuesarray of objects

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

            Show qExcludedValues properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qAndModeboolean

            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.

          • qOneAndOnlyOneboolean

            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.
        • qVariableItemsarray of objects
          Show qVariableItems properties
          • qNamestring

            Name of the variable.

          • qValueobject
            Show qValue properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qDefinitionstring

            The Reporting mode definition of the variable.
        • qSheetIdstring
        • qObjectsarray of objects
          Show qObjects properties
          • qIdstring
          • qActiveboolean
          • qShowModeinteger

            format = byte

          • qScrollPosobject
            Show qScrollPos properties
            • qUsePositionboolean
            • qPosobject
              Show qPos properties
              • qxinteger

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

                format = int32

              • qyinteger

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

                format = int32

        • qApplyLayoutStateboolean

          default = false

        • qShowPopupInfoboolean

          default = false

        • qInfoTextstring
        • qOwnerstring
        • qGroupsarray of objects
          Show qGroups properties
          • qIdstring
          • qCyclePosinteger

            format = int32

        • qShowobject
          Show qShow properties
          • qAlwaysboolean

            default = true

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
        • qApplyInputFieldValuesboolean

          default = true

        • qInputFieldItemsarray of objects
          Show qInputFieldItems properties
          • qFieldNamestring
          • qValuesarray of objects
            Show qValues properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qPackedHashKeysarray of integers
        • qObjectsLayoutarray of objects
          Show qObjectsLayout properties
          • qIdstring
          • qActiveboolean
          • qShowModeinteger

            format = byte

          • qScrollPosobject
            Show qScrollPos properties
            • qUsePositionboolean
            • qPosobject
              Show qPos properties
              • qxinteger

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

                format = int32

              • qyinteger

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

                format = int32

          • qExpansionInfoarray of objects
            Show qExpansionInfo properties
            • qExcludeListboolean
            • qPosobject
              Show qPos properties
              • qDimNamestring
              • qElemNoarray of integers
              • qElemValuesarray of strings
          • qLeftCollapsedboolean
          • qTopCollapsedboolean
          • qSortDataarray of objects
            Show qSortData properties
            • qNamestring
            • qReversedboolean
          • qDimensionGroupPosarray of objects
            Show qDimensionGroupPos properties
            • qGroupNamestring
            • qCurrentItemNamestring
          • qExpressionGroupPosarray of objects
            Show qExpressionGroupPos properties
            • qGroupNamestring
            • qCurrentItemNamestring
          • qUseGraphModeboolean
          • qGraphModestring

            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"

          • qActiveContainerChildObjectIdstring
          • qExtendedPivotStateobject
            Show qExtendedPivotState properties
            • qExpressionPositioninteger

              format = byte

            • qNumberOfLeftDimensionsinteger

              format = byte

            • qDimensionNamesarray of strings
            • qEnableConditionsarray of strings
        • qIncludeSelectionStateboolean

          default = true

        • qIncludeScrollPositionboolean
        • qAlternateStateDataarray of objects
          Show qAlternateStateData properties
          • qStateNamestring

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

          • qFieldItemsarray of objects

            List of the selections.

            Show qFieldItems properties
            • qDefobject
              Show qDef properties
              • qNamestring

                Name of the field.

              • qTypestring

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

            • qLockedboolean

              Indicates if the field is locked. Default is false.

            • qSelectInfoobject
              Show qSelectInfo properties
              • qTextSearchstring

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

              • qRangeLonumber

                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

              • qRangeHinumber

                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

              • qNumberFormatobject

                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
                • qTypestring

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

                • qnDecinteger

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThouinteger

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

                  default = 0, format = int32, default = 0

                • qFmtstring

                  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.

                • qDecstring

                  Defines the decimal separator. Example: .

                • qThoustring

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRangeInfoarray 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
                • qRangeLonumber

                  Lowest value in the range.

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

                • qRangeHinumber

                  Highest value in the range.

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

                • qMeasurestring

                  Label of the measure.
              • qSoftLockboolean

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

                default = false

              • qContinuousRangeInfoarray of objects

                List of information about ranges for selections.

                Show qContinuousRangeInfo properties
                • qMinnumber

                  Lowest value in the range

                  format = double

                • qMaxnumber

                  Highest value in the range

                  format = double

                • qMinInclEqboolean

                  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.

                • qMaxInclEqboolean

                  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.
              • qSelectFieldSearchboolean

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

                default = false

            • qValuesarray of objects
              Show qValues properties
              • qTextstring

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

              • qIsNumericboolean

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

              • qNumbernumber

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

                format = double

            • qExcludedValuesarray of objects

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

              Show qExcludedValues properties
              • qTextstring

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

              • qIsNumericboolean

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

              • qNumbernumber

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

                format = double

            • qAndModeboolean

              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.

            • qOneAndOnlyOneboolean

              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.
        • qForAnnotationsboolean
        • qIncludeAllVariablesboolean

          default = false

      • qClassicMetadataobject
        Show qClassicMetadata properties
        • qSharedboolean
        • qUtcModifyTimenumber

          format = double

        • qSheetIdstring
        • qTemporaryboolean
        • qRestrictedAccessboolean
        • qAccessListarray of strings
        • qPersonalEditionHash_OBSOLETEstring
        • qHiddenboolean

          default = false

        • qLinkedToarray of strings
  • qEmbeddedSnapshotRefobject
    Show qEmbeddedSnapshotRef properties
    • qPropertiesobject
      Show qProperties properties
      • qInfoobject
        Show qInfo properties
        • qIdstring

          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.

        • qTypestring

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

        Used to collect meta data.

        Properties

        Semantic type with an empty structure.

      • qIncludeVariablesboolean
        Experimental

        If true all variables will be stored in the bookmark.

        default = false

      • qDistinctValuesboolean
        Experimental

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

        default = false

    • qBookmarkobject
      Show qBookmark properties
      • qStateDataarray of objects

        List of selections for each state.

        Show qStateData properties
        • qStateNamestring

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

        • qFieldItemsarray of objects

          List of the selections.

          Show qFieldItems properties
          • qDefobject
            Show qDef properties
            • qNamestring

              Name of the field.

            • qTypestring

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

          • qLockedboolean

            Indicates if the field is locked. Default is false.

          • qSelectInfoobject
            Show qSelectInfo properties
            • qTextSearchstring

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

            • qRangeLonumber

              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

            • qRangeHinumber

              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

            • qNumberFormatobject

              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
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

                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.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRangeInfoarray 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
              • qRangeLonumber

                Lowest value in the range.

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

              • qRangeHinumber

                Highest value in the range.

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

              • qMeasurestring

                Label of the measure.
            • qSoftLockboolean

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

              default = false

            • qContinuousRangeInfoarray of objects

              List of information about ranges for selections.

              Show qContinuousRangeInfo properties
              • qMinnumber

                Lowest value in the range

                format = double

              • qMaxnumber

                Highest value in the range

                format = double

              • qMinInclEqboolean

                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.

              • qMaxInclEqboolean

                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.
            • qSelectFieldSearchboolean

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

              default = false

          • qValuesarray of objects
            Show qValues properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qExcludedValuesarray of objects

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

            Show qExcludedValues properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qAndModeboolean

            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.

          • qOneAndOnlyOneboolean

            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.
      • qUtcModifyTimenumber

        Time when the bookmark was created.

        format = double

      • qVariableItemsarray of objects

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

        Show qVariableItems properties
        • qNamestring

          Name of the variable.

        • qValueobject
          Show qValue properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qDefinitionstring

          The Reporting mode definition of the variable.
      • qPatchesarray of objects

        Softpatches to be applied with this bookmark.

        Show qPatches properties
        • qInfoobject
          Show qInfo properties
          • qIdstring

            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.

          • qTypestring

            Type of the object. This parameter is mandatory.
        • qPatchesarray of objects

          Array with patches.

          Show qPatches properties
          • qOpstring

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

          • qPathstring

            Path to the property to add, remove or replace.

          • qValuestring

            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""
        • qChildrenarray of undefineds

          Array with child objects and their patches.
      • qCyclicGroupStatesarray of objects

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

        Show qCyclicGroupStates properties
        • qInfoobject
          Show qInfo properties
          • qIdstring

            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.

          • qTypestring

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

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

          format = int32

      • qGroupStatesarray of objects
        Experimental

        Information about cyclic groups indexed by field definition.

        Show qGroupStates properties
        • qInfoobject
          Show qInfo properties
          • qIdstring

            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.

          • qTypestring

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

          String defining the active field.
    • qClassicBookmarkobject
      Show qClassicBookmark properties
      • qIdstring
      • qNamestring
      • qUtcModifyTimenumber

        format = double

      • qUtcRecallTimenumber

        format = double

      • qRecallCountinteger

        format = int32

      • qApplyAdditiveboolean
      • qFieldItemsarray of objects
        Show qFieldItems properties
        • qDefobject
          Show qDef properties
          • qNamestring

            Name of the field.

          • qTypestring

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

        • qLockedboolean

          Indicates if the field is locked. Default is false.

        • qSelectInfoobject
          Show qSelectInfo properties
          • qTextSearchstring

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

          • qRangeLonumber

            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

          • qRangeHinumber

            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

          • qNumberFormatobject

            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
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

              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.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRangeInfoarray 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
            • qRangeLonumber

              Lowest value in the range.

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

            • qRangeHinumber

              Highest value in the range.

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

            • qMeasurestring

              Label of the measure.
          • qSoftLockboolean

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

            default = false

          • qContinuousRangeInfoarray of objects

            List of information about ranges for selections.

            Show qContinuousRangeInfo properties
            • qMinnumber

              Lowest value in the range

              format = double

            • qMaxnumber

              Highest value in the range

              format = double

            • qMinInclEqboolean

              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.

            • qMaxInclEqboolean

              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.
          • qSelectFieldSearchboolean

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

            default = false

        • qValuesarray of objects
          Show qValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qExcludedValuesarray of objects

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

          Show qExcludedValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qAndModeboolean

          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.

        • qOneAndOnlyOneboolean

          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.
      • qVariableItemsarray of objects
        Show qVariableItems properties
        • qNamestring

          Name of the variable.

        • qValueobject
          Show qValue properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qDefinitionstring

          The Reporting mode definition of the variable.
      • qSheetIdstring
      • qObjectsarray of objects
        Show qObjects properties
        • qIdstring
        • qActiveboolean
        • qShowModeinteger

          format = byte

        • qScrollPosobject
          Show qScrollPos properties
          • qUsePositionboolean
          • qPosobject
            Show qPos properties
            • qxinteger

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

              format = int32

            • qyinteger

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

              format = int32

      • qApplyLayoutStateboolean

        default = false

      • qShowPopupInfoboolean

        default = false

      • qInfoTextstring
      • qOwnerstring
      • qGroupsarray of objects
        Show qGroups properties
        • qIdstring
        • qCyclePosinteger

          format = int32

      • qShowobject
        Show qShow properties
        • qAlwaysboolean

          default = true

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
      • qApplyInputFieldValuesboolean

        default = true

      • qInputFieldItemsarray of objects
        Show qInputFieldItems properties
        • qFieldNamestring
        • qValuesarray of objects
          Show qValues properties
          • qTextstring

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

          • qIsNumericboolean

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

          • qNumbernumber

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

            format = double

        • qPackedHashKeysarray of integers
      • qObjectsLayoutarray of objects
        Show qObjectsLayout properties
        • qIdstring
        • qActiveboolean
        • qShowModeinteger

          format = byte

        • qScrollPosobject
          Show qScrollPos properties
          • qUsePositionboolean
          • qPosobject
            Show qPos properties
            • qxinteger

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

              format = int32

            • qyinteger

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

              format = int32

        • qExpansionInfoarray of objects
          Show qExpansionInfo properties
          • qExcludeListboolean
          • qPosobject
            Show qPos properties
            • qDimNamestring
            • qElemNoarray of integers
            • qElemValuesarray of strings
        • qLeftCollapsedboolean
        • qTopCollapsedboolean
        • qSortDataarray of objects
          Show qSortData properties
          • qNamestring
          • qReversedboolean
        • qDimensionGroupPosarray of objects
          Show qDimensionGroupPos properties
          • qGroupNamestring
          • qCurrentItemNamestring
        • qExpressionGroupPosarray of objects
          Show qExpressionGroupPos properties
          • qGroupNamestring
          • qCurrentItemNamestring
        • qUseGraphModeboolean
        • qGraphModestring

          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"

        • qActiveContainerChildObjectIdstring
        • qExtendedPivotStateobject
          Show qExtendedPivotState properties
          • qExpressionPositioninteger

            format = byte

          • qNumberOfLeftDimensionsinteger

            format = byte

          • qDimensionNamesarray of strings
          • qEnableConditionsarray of strings
      • qIncludeSelectionStateboolean

        default = true

      • qIncludeScrollPositionboolean
      • qAlternateStateDataarray of objects
        Show qAlternateStateData properties
        • qStateNamestring

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

        • qFieldItemsarray of objects

          List of the selections.

          Show qFieldItems properties
          • qDefobject
            Show qDef properties
            • qNamestring

              Name of the field.

            • qTypestring

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

          • qLockedboolean

            Indicates if the field is locked. Default is false.

          • qSelectInfoobject
            Show qSelectInfo properties
            • qTextSearchstring

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

            • qRangeLonumber

              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

            • qRangeHinumber

              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

            • qNumberFormatobject

              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
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

                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.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRangeInfoarray 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
              • qRangeLonumber

                Lowest value in the range.

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

              • qRangeHinumber

                Highest value in the range.

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

              • qMeasurestring

                Label of the measure.
            • qSoftLockboolean

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

              default = false

            • qContinuousRangeInfoarray of objects

              List of information about ranges for selections.

              Show qContinuousRangeInfo properties
              • qMinnumber

                Lowest value in the range

                format = double

              • qMaxnumber

                Highest value in the range

                format = double

              • qMinInclEqboolean

                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.

              • qMaxInclEqboolean

                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.
            • qSelectFieldSearchboolean

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

              default = false

          • qValuesarray of objects
            Show qValues properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qExcludedValuesarray of objects

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

            Show qExcludedValues properties
            • qTextstring

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

            • qIsNumericboolean

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

            • qNumbernumber

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

              format = double

          • qAndModeboolean

            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.

          • qOneAndOnlyOneboolean

            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.
      • qForAnnotationsboolean
      • qIncludeAllVariablesboolean

        default = false

    • qClassicMetadataobject
      Show qClassicMetadata properties
      • qSharedboolean
      • qUtcModifyTimenumber

        format = double

      • qSheetIdstring
      • qTemporaryboolean
      • qRestrictedAccessboolean
      • qAccessListarray of strings
      • qPersonalEditionHash_OBSOLETEstring
      • qHiddenboolean

        default = false

      • qLinkedToarray of strings

schemas GenericObjectLayout object

Is the layout for GenericObjectProperties.

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qExtendsIdstring

    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.

  • qHasSoftPatchesboolean

    Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied).

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code.

      format = int32

  • qSelectionInfoobject
    Show qSelectionInfo properties
    • qInSelectionsboolean

      Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections Method.

    • qMadeSelectionsboolean

      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.
  • qStateNamestring

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

schemas GenericObjectProperties object

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    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.

  • qMetaDefobject

    Used to collect meta data.

    Properties

    Semantic type with an empty structure.

  • qStateNamestring

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

schemas GenericVariableLayout object

Is the layout for GenericVariableProperties.

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qTextstring

    Some text.

  • qNumnumber

    A value.

    format = double

  • qIsScriptCreatedboolean

    If set to true, it means that the variable was defined via script.

schemas GenericVariableProperties object

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    Used to collect meta data.

    Properties

    Semantic type with an empty structure.

  • qNamestring

    Name of the variable. The name must be unique. This parameter is mandatory.

  • qCommentstring

    Comment related to the variable. This parameter is optional.

  • qNumberPresentationobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

    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

  • qDefinitionstring

    Definition of the variable.

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

  • qIdstring
  • qCyclePosinteger

    format = int32

schemas GroupState object

Experimental

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    String defining the active field.

schemas GroupStateInfo object

Properties

  • qGroupNamestring
  • qCurrentItemNamestring

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

  • qStateNamestring

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

  • qSizeobject
    Show qSize properties
    • qcxinteger

      Number of pixels on the x axis.

      format = int32

    • qcyinteger

      Number of pixels on the y axis.

      format = int32

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.
  • qDimensionInfoarray of objects

    Information on the dimension.

    Show qDimensionInfo properties
    • qFallbackTitlestring

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

    • qApprMaxGlyphCountinteger

      Length of the longest value in the field.

      format = int32

    • qCardinalintegerDeprecated

      Number of distinct field values.

      format = int32

    • qLockedboolean

      Is set to true if the field is locked.

    • qSortIndicatorstring

      Can be one of: "N""A""D"

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

    • qGroupPosinteger

      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

    • qStateCountsobject
      Show qStateCounts properties
      • qLockedinteger

        Number of values in locked state.

        format = int32

      • qSelectedinteger

        Number of values in selected state.

        format = int32

      • qOptioninteger

        Number of values in optional state.

        format = int32

      • qDeselectedinteger

        Number of values in deselected state.

        format = int32

      • qAlternativeinteger

        Number of values in alternative state.

        format = int32

      • qExcludedinteger

        Number of values in excluded state.

        format = int32

      • qSelectedExcludedinteger

        Number of values in selected excluded state.

        format = int32

      • qLockedExcludedinteger

        Number of values in locked excluded state.

        format = int32

    • qTagsarray of strings

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

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qDimensionTypestring

      Can be one of: "D""N""T"

    • qReverseSortboolean

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

    • qGroupingstring

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

    • qIsSemanticboolean

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

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

      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.

    • qGroupFieldDefsarray of strings

      Array of field names.

    • qMinnumber

      Minimum value.

      format = double

    • qMaxnumber

      Maximum value.

      format = double

    • qContinuousAxesboolean

      Is continuous axis used.

    • qIsCyclicboolean

      Is a cyclic dimension used.

    • qDerivedFieldboolean

      Is derived field is used as a dimension.

    • qAttrExprInfoarray of objects

      Array of attribute expressions.

      Show qAttrExprInfo properties
      • qMinnumber

        Minimum value.

        format = double

      • qMaxnumber

        Maximum value.

        format = double

      • qFallbackTitlestring
      • qMinTextstring

        String version of the minimum Value.

      • qMaxTextstring

        String version of the maximum Value.

      • qNumFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        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.
    • qAttrDimInfoarray of objects

      Array of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinalinteger

        Cardinality of the attribute expression.

        format = int32

      • qSizeobject
        Show qSize properties
        • qcxinteger

          Number of pixels on the x axis.

          format = int32

        • qcyinteger

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitlestring

        The title for the attribute dimension.

      • qLockedboolean

        The Locked value of the dimension.

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qIsCalculatedboolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsgstring

      The message displayed if calculation condition is not fulfilled.

    • qIsCalculatedboolean

      True if this is a calculated dimension.

      default = false

    • qIsOneAndOnlyOneboolean

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

    • qCardinalitiesobject
      Show qCardinalities properties
      • qCardinalinteger

        Number of distinct field values.

        format = int32

      • qHypercubeCardinalinteger

        Number of distinct hypercube values.

        format = int32

      • qAllValuesCardinalinteger

        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

    • qLibraryIdstring

      Refers to a dimension stored in the library.
  • qMeasureInfoarray of objects

    Information on the measure.

    Show qMeasureInfo properties
    • qFallbackTitlestring

      Corresponds to the label of the measure. If the label is not defined then the measure name is used.

    • qApprMaxGlyphCountinteger

      Length of the longest value in the field.

      format = int32

    • qCardinalinteger

      Number of distinct field values.

      format = int32

    • qSortIndicatorstring

      Can be one of: "N""A""D"

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

      Lowest value in the range.

      format = double

    • qMaxnumber

      Highest value in the range.

      format = double

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qReverseSortboolean

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

    • qIsAutoFormatboolean

      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.

    • qAttrExprInfoarray of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMinnumber

        Minimum value.

        format = double

      • qMaxnumber

        Maximum value.

        format = double

      • qFallbackTitlestring
      • qMinTextstring

        String version of the minimum Value.

      • qMaxTextstring

        String version of the maximum Value.

      • qNumFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        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.
    • qAttrDimInfoarray of objects

      List of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinalinteger

        Cardinality of the attribute expression.

        format = int32

      • qSizeobject
        Show qSize properties
        • qcxinteger

          Number of pixels on the x axis.

          format = int32

        • qcyinteger

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitlestring

        The title for the attribute dimension.

      • qLockedboolean

        The Locked value of the dimension.

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qIsCalculatedboolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsgstring

      The message displayed if calculation condition is not fulfilled.

    • qLibraryIdstring

      Refers to a dimension stored in the library.

    • qTrendLinesarray of objects
      Experimental

      Calculated trendlines

      Show qTrendLines properties
      • qTypestring

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

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qCoeffarray of numbers

        Coefficent c0..cN depending on the trendline type.

      • qR2number

        R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

        format = double

      • qExpressionstring

        Trendline expression

      • qElemNointeger

        Inner Dim elem no

        format = int32

    • qMiniChartobject
      Show qMiniChart properties
      • qYMinnumber

        format = double

      • qYMaxnumber

        format = double

      • qXMinnumber

        format = double

      • qXMaxnumber

        format = double

      • qAttrExprInfoarray of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMinnumber

          Minimum value.

          format = double

        • qMaxnumber

          Maximum value.

          format = double

        • qFallbackTitlestring
        • qMinTextstring

          String version of the minimum Value.

        • qMaxTextstring

          String version of the maximum Value.

        • qNumFormatobject

          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
          • qTypestring

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

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

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

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

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

          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.
      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
  • qEffectiveInterColumnSortOrderarray 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.

  • qGrandTotalRowarray of objects

    Aggregate for measures of all values in the field. The result value depends on the qAggrFunc defined in HyperCubeDef.

    Show qGrandTotalRow properties
    • qTextstring

      Some text. This parameter is optional.

    • qNumnumber

      A value. This parameter is optional.

      format = double

    • qElemNumberinteger

      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

    • qStatestring

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qIsEmptyboolean

      Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

    • qIsTotalCellboolean

      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.

    • qIsOtherCellboolean

      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.

    • qFrequencystring

      Frequency of the value. This parameter is optional.

    • qHighlightRangesobject
      Show qHighlightRanges properties
      • qRangesarray of objects

        Ranges of highlighted values.

        Show qRanges properties
        • qCharPosinteger

          Position of the first search occurrence.

          format = int32

        • qCharCountinteger

          Number of occurrences found.

          format = int32

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

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

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

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

        • qElemNointeger

          Element number.

          format = int32

    • qIsNullboolean

      Is set to true if the value is Null.

    • qMiniChartobject
      Show qMiniChart properties
      • qMatrixarray of arrays

        Array of data.

        Show qMatrix properties
        • qTextstring

          Some text.

        • qNumnumber

          A value. This parameter is optional.

          format = double

        • qElemNumberinteger

          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

        • qAttrExpsobject
          Show qAttrExps properties
          • qValuesarray of objects

            List of attribute expressions values.

            Show qValues properties
            • qTextstring

              Text related to the attribute expression value.

            • qNumnumber

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

              format = double

      • qMinnumber

        format = double

      • qMaxnumber

        format = double

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
    • qInExtRowboolean
  • qDataPagesarray of objects

    Set of data. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

    Show qDataPages properties
    • qMatrixarray of arrays

      Array of data.

      Show qMatrix properties
      • qTextstring

        Some text. This parameter is optional.

      • qNumnumber

        A value. This parameter is optional.

        format = double

      • qElemNumberinteger

        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

      • qStatestring

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmptyboolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCellboolean

        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.

      • qIsOtherCellboolean

        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.

      • qFrequencystring

        Frequency of the value. This parameter is optional.

      • qHighlightRangesobject
        Show qHighlightRanges properties
        • qRangesarray of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPosinteger

            Position of the first search occurrence.

            format = int32

          • qCharCountinteger

            Number of occurrences found.

            format = int32

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

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

            format = double

      • qAttrDimsobject
        Show qAttrDims properties
        • qValuesarray of objects

          List of values.

          Show qValues properties
          • qTextstring

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

          • qElemNointeger

            Element number.

            format = int32

      • qIsNullboolean

        Is set to true if the value is Null.

      • qMiniChartobject
        Show qMiniChart properties
        • qMatrixarray of arrays

          Array of data.

          Show qMatrix properties
          • qTextstring

            Some text.

          • qNumnumber

            A value. This parameter is optional.

            format = double

          • qElemNumberinteger

            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

          • qAttrExpsobject
            Show qAttrExps properties
            • qValuesarray of objects

              List of attribute expressions values.

              Show qValues properties
              • qTextstring

                Text related to the attribute expression value.

              • qNumnumber

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

                format = double

        • qMinnumber

          format = double

        • qMaxnumber

          format = double

        • qErrorobject
          Show qError properties
          • qErrorCodeinteger

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContextstring

            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.

          • qExtendedMessagestring

            Internal information from the server. This parameter is optional.
      • qInExtRowboolean
    • qTailsarray 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
      • qUpinteger

        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

      • qDowninteger

        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

    • qAreaobject
      Show qArea properties
      • qLeftinteger

        Position from the left. Corresponds to the first column.

        format = int32

      • qTopinteger

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidthinteger

        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

      • qHeightinteger

        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

    • qIsReducedboolean

      Is set to true, if the data have been reduced. The default value is false.

      default = false

  • qPivotDataPagesarray of objects

    Set of data for pivot tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

    Show qPivotDataPages properties
    • qLeftarray of objects

      Information about the left dimension values of a pivot table.

      Show qLeft properties
      • qTextstring

        Some text.

      • qElemNointeger

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValuenumber

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpandboolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapseboolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qTypestring

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

      • qUpinteger

        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

      • qDowninteger

        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

      • qSubNodesarray of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

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

            format = double

      • qAttrDimsobject
        Show qAttrDims properties
        • qValuesarray of objects

          List of values.

          Show qValues properties
          • qTextstring

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

          • qElemNointeger

            Element number.

            format = int32

    • qToparray 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
      • qTextstring

        Some text.

      • qElemNointeger

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValuenumber

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpandboolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapseboolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qTypestring

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

      • qUpinteger

        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

      • qDowninteger

        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

      • qSubNodesarray of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

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

            format = double

      • qAttrDimsobject
        Show qAttrDims properties
        • qValuesarray of objects

          List of values.

          Show qValues properties
          • qTextstring

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

          • qElemNointeger

            Element number.

            format = int32

    • qDataarray of arrays

      Array of data.

      Show qData properties
      • qLabelstring

        Label of the cell. This parameter is optional.

      • qTextstring

        Some text related to the cell.

      • qNumnumber

        Value of the cell.

        format = double

      • qTypestring

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

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

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

            format = double

      • qAttrDimsobject
        Show qAttrDims properties
        • qValuesarray of objects

          List of values.

          Show qValues properties
          • qTextstring

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

          • qElemNointeger

            Element number.

            format = int32

    • qAreaobject
      Show qArea properties
      • qLeftinteger

        Position from the left. Corresponds to the first column.

        format = int32

      • qTopinteger

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidthinteger

        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

      • qHeightinteger

        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

  • qStackedDataPagesarray of objects

    Set of data for stacked tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

    Show qStackedDataPages properties
    • qDataarray of objects

      Array of data.

      Show qData properties
      • qTextstring

        Some text.

      • qElemNointeger

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValuenumber

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpandboolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapseboolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qTypestring

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

      • qMaxPosnumber

        Total of the positive values in the current group of cells.

        format = double

      • qMinNegnumber

        Total of the negative values in the current group of cells.

        format = double

      • qUpinteger

        Number of elements that are part of the previous tail.

        format = int32

      • qDowninteger

        Number of elements that are part of the next tail.

        format = int32

      • qRowinteger

        Row index in the data matrix. The indexing starts from 0.

        format = int32

      • qSubNodesarray of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

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

            format = double

      • qAttrDimsobject
        Show qAttrDims properties
        • qValuesarray of objects

          List of values.

          Show qValues properties
          • qTextstring

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

          • qElemNointeger

            Element number.

            format = int32

    • qAreaobject
      Show qArea properties
      • qLeftinteger

        Position from the left. Corresponds to the first column.

        format = int32

      • qTopinteger

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidthinteger

        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

      • qHeightinteger

        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

  • qModestring

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

  • qNoOfLeftDimsinteger

    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

  • qIndentModeboolean

    Is used for pivot tables only. If set to true, the formatting of the results is slightly different. This property is optional.

  • qLastExpandedPosobject
    Show qLastExpandedPos properties
    • qxinteger

      Position of the cell on the x-axis.

      format = int32

    • qyinteger

      Position of the cell on the y-axis.

      format = int32

  • qHasOtherValuesboolean

    True if other row exists.

  • qTitlestring

    Title of the hypercube, for example the title of a chart.

  • qTreeNodesOnDimarray of integers

    The total number of nodes on each dimension (only applicable when qMode = T ).

  • qCalcCondMsgstring

    The message displayed if calculation condition is not fulfilled.

  • qColumnOrderarray 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

  • qStateNamestring

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

  • qDimensionsarray of objects

    Array of dimensions.

    Show qDimensions properties
    • qLibraryIdstring

      Refers to a dimension stored in the library.

    • qDefobject
      Show qDef properties
      • qGroupingstring

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

      • qFieldDefsarray of strings

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

      • qFieldLabelsarray of strings

        Array of field labels. This parameter is optional.

      • qSortCriteriasarray of objects

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

        Show qSortCriterias properties
        • qSortByStateinteger

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

          format = int8

        • qSortByFrequencyinteger

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

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qNumberPresentationsarray of objects

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

        Show qNumberPresentations properties
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

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

      • qActiveFieldinteger

        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

      • qLabelExpressionstring

        Label expression. This parameter is optional.

      • qAliasstring

        Alias of the dimension.
    • qNullSuppressionboolean

      If set to true, no null values are returned.

    • qIncludeElemValueboolean
    • qOtherTotalSpecobject
      Show qOtherTotalSpec properties
      • qOtherModestring

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

      • qOtherCountedobject
        Show qOtherCounted properties
        • qvstring

          Expression evaluated to dual.
      • qOtherLimitobject
        Show qOtherLimit properties
        • qvstring

          Expression evaluated to dual.
      • qOtherLimitModestring

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

      • qSuppressOtherboolean

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

        default = false

      • qForceBadValueKeepingboolean

        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

      • qApplyEvenWhenPossiblyWrongResultboolean

        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

      • qGlobalOtherGroupingboolean

        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

      • qOtherCollapseInnerDimensionsboolean

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

        default = false

      • qOtherSortModestring

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

      • qTotalModestring

        Can be one of: "TOTAL_OFF""TOTAL_EXPR"

      • qReferencedExpressionobject
        Show qReferencedExpression properties
        • qvstring

          Expression evaluated to string.
    • qShowTotalboolean
    • qShowAllboolean

      If set to true, all dimension values are shown.

    • qOtherLabelobject
      Show qOtherLabel properties
      • qvstring

        Expression evaluated to string.
    • qTotalLabelobject
      Show qTotalLabel properties
      • qvstring

        Expression evaluated to string.
    • qCalcCondobject
      Show qCalcCond properties
      • qvstring

        Expression evaluated to dual.
    • qAttributeExpressionsarray of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpressionstring

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

      • qLibraryIdstring

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

      • qAttributeboolean

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

      • qNumFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        Label of the attribute expression.

      • qLabelExpressionstring

        Optional expression used for dynamic label.
    • qAttributeDimensionsarray of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDefstring

        Expression or field name.

      • qLibraryIdstring

        LibraryId for dimension.

      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

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

          format = int8

        • qSortByFrequencyinteger

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

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qAttributeboolean

        If set to true, this attribute will not affect the number of rows in the cube.
    • qCalcConditionobject
      Show qCalcCondition properties
      • qCondobject
        Show qCond properties
        • qvstring

          Expression evaluated to dual.
      • qMsgobject
        Show qMsg properties
        • qvstring

          Expression evaluated to string.
  • qMeasuresarray of objects

    Array of measures.

    Show qMeasures properties
    • qLibraryIdstring

      Refers to a measure stored in the library.

    • qDefobject
      Show qDef properties
      • qLabelstring

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

      • qDescriptionstring

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

      • qTagsarray of strings

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

      • qGroupingstring

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

      • qDefstring

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

      • qNumFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

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

      • qBrutalSumboolean

        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 .

      • qAggrFuncstring

        Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

      • qAccumulateinteger
        • 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

      • qReverseSortboolean

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

      • qActiveExpressioninteger

        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

      • qExpressionsarray 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.

      • qLabelExpressionstring

        Label expression. This parameter is optional.
    • qSortByobject
      Show qSortBy properties
      • qSortByStateinteger

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

        format = int8

      • qSortByFrequencyinteger

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

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qAttributeExpressionsarray of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpressionstring

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

      • qLibraryIdstring

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

      • qAttributeboolean

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

      • qNumFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        Label of the attribute expression.

      • qLabelExpressionstring

        Optional expression used for dynamic label.
    • qAttributeDimensionsarray of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDefstring

        Expression or field name.

      • qLibraryIdstring

        LibraryId for dimension.

      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

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

          format = int8

        • qSortByFrequencyinteger

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

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qAttributeboolean

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

        Expression evaluated to dual.
    • qCalcConditionobject
      Show qCalcCondition properties
      • qCondobject
        Show qCond properties
        • qvstring

          Expression evaluated to dual.
      • qMsgobject
        Show qMsg properties
        • qvstring

          Expression evaluated to string.
    • qTrendLinesarray of objects
      Experimental

      Specifies trendlines for this measure.

      Show qTrendLines properties
      • qTypestring

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

      • qXColIxinteger

        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

      • qCalcR2boolean

        Set to true to calulatate the R2 score

        default = false

      • qContinuousXAxisstring

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

      • qMultiDimModestring

        Can be one of: "Multi""Sum"

    • qMiniChartDefobject
      Show qMiniChartDef properties
      • qDefstring

        Expression or field name.

      • qLibraryIdstring

        LibraryId for dimension.

      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

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

          format = int8

        • qSortByFrequencyinteger

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

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qOtherTotalSpecobject
        Show qOtherTotalSpec properties
        • qOtherModestring

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

        • qOtherCountedobject
          Show qOtherCounted properties
          • qvstring

            Expression evaluated to dual.
        • qOtherLimitobject
          Show qOtherLimit properties
          • qvstring

            Expression evaluated to dual.
        • qOtherLimitModestring

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

        • qSuppressOtherboolean

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

          default = false

        • qForceBadValueKeepingboolean

          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

        • qApplyEvenWhenPossiblyWrongResultboolean

          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

        • qGlobalOtherGroupingboolean

          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

        • qOtherCollapseInnerDimensionsboolean

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

          default = false

        • qOtherSortModestring

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

        • qTotalModestring

          Can be one of: "TOTAL_OFF""TOTAL_EXPR"

        • qReferencedExpressionobject
          Show qReferencedExpression properties
          • qvstring

            Expression evaluated to string.
      • qMaxNumberPointsinteger

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

      • qAttributeExpressionsarray of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpressionstring

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

        • qLibraryIdstring

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

        • qAttributeboolean

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

        • qNumFormatobject

          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
          • qTypestring

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

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

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

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

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

          Label of the attribute expression.

        • qLabelExpressionstring

          Optional expression used for dynamic label.
      • qNullSuppressionboolean

        If set to true, no null values are returned.
  • qInterColumnSortOrderarray 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.

  • qSuppressZeroboolean

    Removes zero values.

    default = false

  • qSuppressMissingboolean

    Removes missing values.

    default = false

  • qInitialDataFetcharray of objects

    Initial data set.

    Show qInitialDataFetch properties
    • qLeftinteger

      Position from the left. Corresponds to the first column.

      format = int32

    • qTopinteger

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidthinteger

      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

    • qHeightinteger

      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

  • qReductionModestring

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

  • qModestring

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

  • qPseudoDimPosinteger

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

  • qNoOfLeftDimsinteger

    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

  • qAlwaysFullyExpandedboolean

    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

  • qMaxStackedCellsinteger

    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

  • qPopulateMissingboolean

    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

  • qShowTotalsAboveboolean

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

    default = false

  • qIndentModeboolean

    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

  • qCalcCondobject
    Show qCalcCond properties
    • qvstring

      Expression evaluated to dual.
  • qSortbyYValueinteger

    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

  • qTitleobject
    Show qTitle properties
    • qvstring

      Expression evaluated to string.
  • qCalcConditionobject
    Show qCalcCondition properties
    • qCondobject
      Show qCond properties
      • qvstring

        Expression evaluated to dual.
    • qMsgobject
      Show qMsg properties
      • qvstring

        Expression evaluated to string.
  • qColumnOrderarray of integers

    The order of the columns.

  • qExpansionStatearray of objects
    Experimental

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

    Show qExpansionState properties
    • qExcludeListboolean
    • qPosobject
      Show qPos properties
      • qDimNamestring
      • qElemNoarray of integers
      • qElemValuesarray of strings
  • qDynamicScriptarray of strings
    Experimental

    Hypercube Modifier Dynamic script string

  • qContextSetExpressionstring

    Set Expression valid for the whole cube. Used to limit computations to the set specified.

  • qSuppressMeasureTotalsboolean

    If set to true, suppress any measure grand totals, ignoring any AggrFunc.

schemas InputFieldItem object

Properties

  • qFieldNamestring
  • qValuesarray of objects
    Show qValues properties
    • qTextstring

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

    • qIsNumericboolean

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

    • qNumbernumber

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

      format = double

  • qPackedHashKeysarray of integers

schemas InterFieldSortData object

Properties

  • qNamestring
  • qReversedboolean

schemas InteractDef object

Properties

  • qTypestring

    Can be one of: "IT_MSGBOX""IT_SCRIPTLINE""IT_BREAK""IT_INPUT""IT_END""IT_PASSWD""IT_USERNAME"

  • qTitlestring

    Title used in the message box dialog. This property is relevant if qType is IT_MSGBOX.

  • qMsgstring

    Message used in the message box dialog. This property is relevant if qType is IT_MSGBOX.

  • qButtonsinteger

    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

  • qLinestring

    Next script statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE.

  • qOldLineNrinteger

    First line number of the previously executed statement. This property is used if the type of interaction is IT_SCRIPTLINE.

    format = int32

  • qNewLineNrinteger

    First line number of the next statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE.

    format = int32

  • qPathstring

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

  • qHiddenboolean

    This property is set to true if the returned statement is an hidden script statement.

  • qResultinteger

    Not relevant for describing the requested user interaction.

    format = int32

  • qInputstring

    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

  • qIdstring
  • qActiveboolean
  • qShowModeinteger

    format = byte

  • qScrollPosobject
    Show qScrollPos properties
    • qUsePositionboolean
    • qPosobject
      Show qPos properties
      • qxinteger

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

        format = int32

      • qyinteger

        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

Meta data about the selection in a field.

Properties

  • qFieldNamestring

    The name of the field.

  • qValuesCountinteger

    Number of selected values in the field.

    format = int32

  • qExcludedValuesCountinteger

    Number of excluded values in the field.

    format = int32

schemas LineageInfo object

Properties

  • qDiscriminatorstring

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

    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

  • qStateNamestring

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

  • qSizeobject
    Show qSize properties
    • qcxinteger

      Number of pixels on the x axis.

      format = int32

    • qcyinteger

      Number of pixels on the y axis.

      format = int32

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.
  • qDimensionInfoobject
    Show qDimensionInfo properties
    • qFallbackTitlestring

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

    • qApprMaxGlyphCountinteger

      Length of the longest value in the field.

      format = int32

    • qCardinalintegerDeprecated

      Number of distinct field values.

      format = int32

    • qLockedboolean

      Is set to true if the field is locked.

    • qSortIndicatorstring

      Can be one of: "N""A""D"

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

    • qGroupPosinteger

      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

    • qStateCountsobject
      Show qStateCounts properties
      • qLockedinteger

        Number of values in locked state.

        format = int32

      • qSelectedinteger

        Number of values in selected state.

        format = int32

      • qOptioninteger

        Number of values in optional state.

        format = int32

      • qDeselectedinteger

        Number of values in deselected state.

        format = int32

      • qAlternativeinteger

        Number of values in alternative state.

        format = int32

      • qExcludedinteger

        Number of values in excluded state.

        format = int32

      • qSelectedExcludedinteger

        Number of values in selected excluded state.

        format = int32

      • qLockedExcludedinteger

        Number of values in locked excluded state.

        format = int32

    • qTagsarray of strings

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

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qDimensionTypestring

      Can be one of: "D""N""T"

    • qReverseSortboolean

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

    • qGroupingstring

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

    • qIsSemanticboolean

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

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

      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.

    • qGroupFieldDefsarray of strings

      Array of field names.

    • qMinnumber

      Minimum value.

      format = double

    • qMaxnumber

      Maximum value.

      format = double

    • qContinuousAxesboolean

      Is continuous axis used.

    • qIsCyclicboolean

      Is a cyclic dimension used.

    • qDerivedFieldboolean

      Is derived field is used as a dimension.

    • qAttrExprInfoarray of objects

      Array of attribute expressions.

      Show qAttrExprInfo properties
      • qMinnumber

        Minimum value.

        format = double

      • qMaxnumber

        Maximum value.

        format = double

      • qFallbackTitlestring
      • qMinTextstring

        String version of the minimum Value.

      • qMaxTextstring

        String version of the maximum Value.

      • qNumFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        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.
    • qAttrDimInfoarray of objects

      Array of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinalinteger

        Cardinality of the attribute expression.

        format = int32

      • qSizeobject
        Show qSize properties
        • qcxinteger

          Number of pixels on the x axis.

          format = int32

        • qcyinteger

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitlestring

        The title for the attribute dimension.

      • qLockedboolean

        The Locked value of the dimension.

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qIsCalculatedboolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsgstring

      The message displayed if calculation condition is not fulfilled.

    • qIsCalculatedboolean

      True if this is a calculated dimension.

      default = false

    • qIsOneAndOnlyOneboolean

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

    • qCardinalitiesobject
      Show qCardinalities properties
      • qCardinalinteger

        Number of distinct field values.

        format = int32

      • qHypercubeCardinalinteger

        Number of distinct hypercube values.

        format = int32

      • qAllValuesCardinalinteger

        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

    • qLibraryIdstring

      Refers to a dimension stored in the library.
  • qExpressionsarray of objects

    Lists the expressions in the list object.

    Show qExpressions properties
    • qExprstring

      Value of the expression.

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code.

        format = int32

  • qDataPagesarray of objects

    Set of data. Is empty if nothing has been defined in qInitialDataFetch in ListObjectDef.

    Show qDataPages properties
    • qMatrixarray of arrays

      Array of data.

      Show qMatrix properties
      • qTextstring

        Some text. This parameter is optional.

      • qNumnumber

        A value. This parameter is optional.

        format = double

      • qElemNumberinteger

        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

      • qStatestring

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmptyboolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCellboolean

        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.

      • qIsOtherCellboolean

        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.

      • qFrequencystring

        Frequency of the value. This parameter is optional.

      • qHighlightRangesobject
        Show qHighlightRanges properties
        • qRangesarray of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPosinteger

            Position of the first search occurrence.

            format = int32

          • qCharCountinteger

            Number of occurrences found.

            format = int32

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

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

            format = double

      • qAttrDimsobject
        Show qAttrDims properties
        • qValuesarray of objects

          List of values.

          Show qValues properties
          • qTextstring

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

          • qElemNointeger

            Element number.

            format = int32

      • qIsNullboolean

        Is set to true if the value is Null.

      • qMiniChartobject
        Show qMiniChart properties
        • qMatrixarray of arrays

          Array of data.

          Show qMatrix properties
          • qTextstring

            Some text.

          • qNumnumber

            A value. This parameter is optional.

            format = double

          • qElemNumberinteger

            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

          • qAttrExpsobject
            Show qAttrExps properties
            • qValuesarray of objects

              List of attribute expressions values.

              Show qValues properties
              • qTextstring

                Text related to the attribute expression value.

              • qNumnumber

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

                format = double

        • qMinnumber

          format = double

        • qMaxnumber

          format = double

        • qErrorobject
          Show qError properties
          • qErrorCodeinteger

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContextstring

            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.

          • qExtendedMessagestring

            Internal information from the server. This parameter is optional.
      • qInExtRowboolean
    • qTailsarray 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
      • qUpinteger

        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

      • qDowninteger

        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

    • qAreaobject
      Show qArea properties
      • qLeftinteger

        Position from the left. Corresponds to the first column.

        format = int32

      • qTopinteger

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidthinteger

        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

      • qHeightinteger

        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

    • qIsReducedboolean

      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

  • qStateNamestring

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

  • qLibraryIdstring

    Refers to a dimension stored in the library.

  • qDefobject
    Show qDef properties
    • qGroupingstring

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

    • qFieldDefsarray of strings

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

    • qFieldLabelsarray of strings

      Array of field labels. This parameter is optional.

    • qSortCriteriasarray of objects

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

      Show qSortCriterias properties
      • qSortByStateinteger

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

        format = int8

      • qSortByFrequencyinteger

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

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qNumberPresentationsarray of objects

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

      Show qNumberPresentations properties
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

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

    • qActiveFieldinteger

      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

    • qLabelExpressionstring

      Label expression. This parameter is optional.

    • qAliasstring

      Alias of the dimension.
  • qAutoSortByStateobject
    Show qAutoSortByState properties
    • qDisplayNumberOfRowsinteger

      This parameter applies to list objects. If the total number of values in the list object is greater than the value set in qDisplayNumberOfRows , the selected lines are promoted at 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

  • qFrequencyModestring

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

  • qShowAlternativesboolean

    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.

  • qInitialDataFetcharray of objects

    Fetches an initial data set.

    Show qInitialDataFetch properties
    • qLeftinteger

      Position from the left. Corresponds to the first column.

      format = int32

    • qTopinteger

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidthinteger

      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

    • qHeightinteger

      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

  • qExpressionsarray of objects

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

    Show qExpressions properties
    • qExprstring

      Value of the expression.

    • qLibraryIdstring

      Refers to an expression stored in the library.
  • qDirectQuerySimplifiedViewboolean
    Experimental

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

schemas LocaleInfo object

Properties

  • qDecimalSepstring

    Decimal separator.

  • qThousandSepstring

    Thousand separator.

  • qListSepstring

    List separator.

  • qMoneyDecimalSepstring

    Money decimal separator.

  • qMoneyThousandSepstring

    Money thousand separator.

  • qCurrentYearinteger

    Current year.

    format = int32

  • qMoneyFmtstring

    Money format. Example: #.##0,00 kr;-#.##0,00 kr

  • qTimeFmtstring

    Time format. Example: hh:mm:ss

  • qDateFmtstring

    Date format. Example: YYYY-MM-DD

  • qTimestampFmtstring

    Time stamp format. Example: YYYY-MM-DD hh:mm:ss[.fff]

  • qCalendarStringsobject
    Show qCalendarStrings properties
    • qDayNamesarray of strings

      List of short day names.

    • qMonthNamesarray of strings

      List of short month names.

    • qLongDayNamesarray of strings

      List of long day names.

    • qLongMonthNamesarray of strings

      List of long month names.
  • qFirstWeekDayinteger

    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

  • qBrokenWeeksboolean

    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.

  • qReferenceDayinteger

    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

  • qFirstMonthOfYearinteger

    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

  • qCollationstring

    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.

  • qNumericalAbbreviationstring

    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

  • qItemsarray of objects

    Information about the list of measures.

    Show qItems properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      Layout for NxMetaDef.

      Show qMeta properties
      • qNamestring

        Name. This property is optional.
    • qDataobject

      Contains dynamic JSON data specified by the client.

schemas MeasureListDef object

Defines the list of measures.

Properties

  • qTypestring

    Type of the list.

  • qDataobject

    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

  • qItemsarray 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
    • qUrlDefstring

      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.
    • qUrlstring

      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

  • qUrlDefstring

    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.
  • qUrlstring

    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

  • qSharedboolean
  • qUtcModifyTimenumber

    format = double

  • qSheetIdstring
  • qTemporaryboolean
  • qRestrictedAccessboolean
  • qAccessListarray of strings
  • qPersonalEditionHash_OBSOLETEstring
  • qHiddenboolean

    default = false

  • qLinkedToarray 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

  • qTitlestring

    Title of the app.

  • qFileNamestring

    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.

  • qLastReloadTimestring

    Date and time of the last reload of the app in ISO format.

  • qModifiedboolean

    Is set to true if the app has been updated since the last save.

  • qHasScriptboolean

    Is set to true if a script is defined in the app.

  • qStateNamesarray of strings

    Array of alternate states.

  • qMetaobject

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qLocaleInfoobject
    Show qLocaleInfo properties
    • qDecimalSepstring

      Decimal separator.

    • qThousandSepstring

      Thousand separator.

    • qListSepstring

      List separator.

    • qMoneyDecimalSepstring

      Money decimal separator.

    • qMoneyThousandSepstring

      Money thousand separator.

    • qCurrentYearinteger

      Current year.

      format = int32

    • qMoneyFmtstring

      Money format. Example: #.##0,00 kr;-#.##0,00 kr

    • qTimeFmtstring

      Time format. Example: hh:mm:ss

    • qDateFmtstring

      Date format. Example: YYYY-MM-DD

    • qTimestampFmtstring

      Time stamp format. Example: YYYY-MM-DD hh:mm:ss[.fff]

    • qCalendarStringsobject
      Show qCalendarStrings properties
      • qDayNamesarray of strings

        List of short day names.

      • qMonthNamesarray of strings

        List of short month names.

      • qLongDayNamesarray of strings

        List of long day names.

      • qLongMonthNamesarray of strings

        List of long month names.
    • qFirstWeekDayinteger

      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

    • qBrokenWeeksboolean

      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.

    • qReferenceDayinteger

      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

    • qFirstMonthOfYearinteger

      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

    • qCollationstring

      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.

    • qNumericalAbbreviationstring

      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
  • qHasDataboolean

    Is set to true if the app contains data following a script reload.

  • qReadOnlyboolean

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

  • qIsOpenedWithoutDataboolean

    If set to true, it means that the app was opened without loading its data.

  • qIsSessionAppboolean

    If set to true, the app is a Session App, i.e. not persistent.

  • qProhibitBinaryLoadboolean

    If set to true, the persisted app cannot be used in a Binary load statement in Qlik load script.

  • qThumbnailobject
    In addition, this structure can return dynamic properties.
    Show qThumbnail properties
    • qUrlstring

      Relative path of the thumbnail.
  • qIsBDILiveModeboolean

    If set to true, the app is in BDI Direct Query Mode.

  • qIsDirectQueryModeboolean

    If set to true, the app is in Direct Query Mode.

  • qUnsupportedFeaturesarray 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"

  • qUsagestring

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

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

  • qTitlestring

    App title.

  • qLastReloadTimestring

    Last reload time of the app.

  • qMigrationHashstring

    Internal property reserved for app migration. Patch version of the app. Do not update.

  • qSavedInProductVersionstring

    Internal property reserved for app migration. The app is saved in this version of the product. Do not update.

  • qThumbnailobject
    In addition, this structure can contain dynamic properties.
    Show qThumbnail properties
    • qUrlstring

      Relative path of the thumbnail.
  • qHasSectionAccessboolean

    If true the app has section access configured.

  • qUsagestring

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

schemas NxAttrDimDef object

Layout for NxAttrDimDef.

Properties

  • qDefstring

    Expression or field name.

  • qLibraryIdstring

    LibraryId for dimension.

  • qSortByobject
    Show qSortBy properties
    • qSortByStateinteger

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

      format = int8

    • qSortByFrequencyinteger

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

      format = int8

    • qSortByNumericinteger

      Sorts the field values by numeric value.

      format = int8

    • qSortByAsciiinteger

      Sorts the field by alphabetical order.

      format = int8

    • qSortByLoadOrderinteger

      Sorts the field values by the initial load order.

      format = int8

    • qSortByExpressioninteger

      Sorts the field by expression.

      format = int8

    • qExpressionobject
      Show qExpression properties
      • qvstring

        Expression evaluated to dual.
    • qSortByGreynessinteger

      format = int8

  • qAttributeboolean

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

schemas NxAttrDimInfo object

Layout for NxAttrDimDef.

Properties

  • qCardinalinteger

    Cardinality of the attribute expression.

    format = int32

  • qSizeobject
    Show qSize properties
    • qcxinteger

      Number of pixels on the x axis.

      format = int32

    • qcyinteger

      Number of pixels on the y axis.

      format = int32

  • qFallbackTitlestring

    The title for the attribute dimension.

  • qLockedboolean

    The Locked value of the dimension.

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.
  • qIsCalculatedboolean

    True if this is a calculated dimension.

    default = false

schemas NxAttrExprDef object

Properties

  • qExpressionstring

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

  • qLibraryIdstring

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

  • qAttributeboolean

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

  • qNumFormatobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

    Label of the attribute expression.

  • qLabelExpressionstring

    Optional expression used for dynamic label.

schemas NxAttrExprInfo object

Layout for NxAttrExprDef.

Properties

  • qMinnumber

    Minimum value.

    format = double

  • qMaxnumber

    Maximum value.

    format = double

  • qFallbackTitlestring
  • qMinTextstring

    String version of the minimum Value.

  • qMaxTextstring

    String version of the maximum Value.

  • qNumFormatobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

    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

  • qValuesarray of objects

    List of values.

    Show qValues properties
    • qTextstring

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

    • qElemNointeger

      Element number.

      format = int32

schemas NxAttributeExpressionValues object

Properties

  • qValuesarray of objects

    List of attribute expressions values.

    Show qValues properties
    • qTextstring

      Text related to the attribute expression value.

    • qNumnumber

      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

  • qDisplayNumberOfRowsinteger

    This parameter applies to list objects. If the total number of values in the list object is greater than the value set in qDisplayNumberOfRows , the selected lines are promoted at 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

  • qAxisarray of objects

    List of axis data.

    Show qAxis properties
    • qNamestring

      Name of the derived definition.

    • qTagsarray of strings

      List of tags.

    • qTicksarray of objects

      List of ticks.

      Show qTicks properties
      • qTextstring

        Tick's label.

      • qStartnumber

        Start value.

        format = double

      • qEndnumber

        End value.

        format = double

schemas NxAxisTicks object

Properties

  • qNamestring

    Name of the derived definition.

  • qTagsarray of strings

    List of tags.

  • qTicksarray of objects

    List of ticks.

    Show qTicks properties
    • qTextstring

      Tick's label.

    • qStartnumber

      Start value.

      format = double

    • qEndnumber

      End value.

      format = double

schemas NxBookmark object

Properties

  • qStateDataarray of objects

    List of selections for each state.

    Show qStateData properties
    • qStateNamestring

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

    • qFieldItemsarray of objects

      List of the selections.

      Show qFieldItems properties
      • qDefobject
        Show qDef properties
        • qNamestring

          Name of the field.

        • qTypestring

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

      • qLockedboolean

        Indicates if the field is locked. Default is false.

      • qSelectInfoobject
        Show qSelectInfo properties
        • qTextSearchstring

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

        • qRangeLonumber

          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

        • qRangeHinumber

          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

        • qNumberFormatobject

          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
          • qTypestring

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

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

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

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRangeInfoarray 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
          • qRangeLonumber

            Lowest value in the range.

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

          • qRangeHinumber

            Highest value in the range.

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

          • qMeasurestring

            Label of the measure.
        • qSoftLockboolean

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

          default = false

        • qContinuousRangeInfoarray of objects

          List of information about ranges for selections.

          Show qContinuousRangeInfo properties
          • qMinnumber

            Lowest value in the range

            format = double

          • qMaxnumber

            Highest value in the range

            format = double

          • qMinInclEqboolean

            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.

          • qMaxInclEqboolean

            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.
        • qSelectFieldSearchboolean

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

          default = false

      • qValuesarray of objects
        Show qValues properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qExcludedValuesarray of objects

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

        Show qExcludedValues properties
        • qTextstring

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

        • qIsNumericboolean

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

        • qNumbernumber

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

          format = double

      • qAndModeboolean

        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.

      • qOneAndOnlyOneboolean

        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.
  • qUtcModifyTimenumber

    Time when the bookmark was created.

    format = double

  • qVariableItemsarray of objects

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

    Show qVariableItems properties
    • qNamestring

      Name of the variable.

    • qValueobject
      Show qValue properties
      • qTextstring

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

      • qIsNumericboolean

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

      • qNumbernumber

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

        format = double

    • qDefinitionstring

      The Reporting mode definition of the variable.
  • qPatchesarray of objects

    Softpatches to be applied with this bookmark.

    Show qPatches properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qPatchesarray of objects

      Array with patches.

      Show qPatches properties
      • qOpstring

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

      • qPathstring

        Path to the property to add, remove or replace.

      • qValuestring

        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""
    • qChildrenarray of undefineds

      Array with child objects and their patches.
  • qCyclicGroupStatesarray of objects

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

    Show qCyclicGroupStates properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

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

      format = int32

  • qGroupStatesarray of objects
    Experimental

    Information about cyclic groups indexed by field definition.

    Show qGroupStates properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

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

      String defining the active field.

schemas NxCalcCond object

Properties

  • qCondobject
    Show qCond properties
    • qvstring

      Expression evaluated to dual.
  • qMsgobject
    Show qMsg properties
    • qvstring

      Expression evaluated to string.

schemas NxCardinalities object

Properties

  • qCardinalinteger

    Number of distinct field values.

    format = int32

  • qHypercubeCardinalinteger

    Number of distinct hypercube values.

    format = int32

  • qAllValuesCardinalinteger

    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

  • qTextstring

    Some text. This parameter is optional.

  • qNumnumber

    A value. This parameter is optional.

    format = double

  • qElemNumberinteger

    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

  • qStatestring

    Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

  • qIsEmptyboolean

    Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

  • qIsTotalCellboolean

    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.

  • qIsOtherCellboolean

    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.

  • qFrequencystring

    Frequency of the value. This parameter is optional.

  • qHighlightRangesobject
    Show qHighlightRanges properties
    • qRangesarray of objects

      Ranges of highlighted values.

      Show qRanges properties
      • qCharPosinteger

        Position of the first search occurrence.

        format = int32

      • qCharCountinteger

        Number of occurrences found.

        format = int32

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

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

        format = double

  • qAttrDimsobject
    Show qAttrDims properties
    • qValuesarray of objects

      List of values.

      Show qValues properties
      • qTextstring

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

      • qElemNointeger

        Element number.

        format = int32

  • qIsNullboolean

    Is set to true if the value is Null.

  • qMiniChartobject
    Show qMiniChart properties
    • qMatrixarray of arrays

      Array of data.

      Show qMatrix properties
      • qTextstring

        Some text.

      • qNumnumber

        A value. This parameter is optional.

        format = double

      • qElemNumberinteger

        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

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

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

            format = double

    • qMinnumber

      format = double

    • qMaxnumber

      format = double

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
  • qInExtRowboolean

schemas NxCellPosition object

Properties

  • qxinteger

    Position of the cell on the x-axis.

    format = int32

  • qyinteger

    Position of the cell on the y-axis.

    format = int32

schemas NxCellRows object[]

Element properties

  • qTextstring

    Some text. This parameter is optional.

  • qNumnumber

    A value. This parameter is optional.

    format = double

  • qElemNumberinteger

    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

  • qStatestring

    Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

  • qIsEmptyboolean

    Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

  • qIsTotalCellboolean

    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.

  • qIsOtherCellboolean

    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.

  • qFrequencystring

    Frequency of the value. This parameter is optional.

  • qHighlightRangesobject
    Show qHighlightRanges properties
    • qRangesarray of objects

      Ranges of highlighted values.

      Show qRanges properties
      • qCharPosinteger

        Position of the first search occurrence.

        format = int32

      • qCharCountinteger

        Number of occurrences found.

        format = int32

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

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

        format = double

  • qAttrDimsobject
    Show qAttrDims properties
    • qValuesarray of objects

      List of values.

      Show qValues properties
      • qTextstring

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

      • qElemNointeger

        Element number.

        format = int32

  • qIsNullboolean

    Is set to true if the value is Null.

  • qMiniChartobject
    Show qMiniChart properties
    • qMatrixarray of arrays

      Array of data.

      Show qMatrix properties
      • qTextstring

        Some text.

      • qNumnumber

        A value. This parameter is optional.

        format = double

      • qElemNumberinteger

        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

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

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

            format = double

    • qMinnumber

      format = double

    • qMaxnumber

      format = double

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
  • qInExtRowboolean

schemas NxContainerEntry object

Properties

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

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

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qDataobject

    Contains dynamic JSON data specified by the client.

schemas NxContinuousDataOptions object

Properties

  • qStartnumber

    Start value.

    format = double

  • qEndnumber

    End value.

    format = double

  • qNbrPointsinteger

    Number of bins for binning.

    format = int32

  • qMaxNbrTicksinteger

    Maximum number of ticks.

    format = int32

  • qMaxNumberLinesinteger

    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

  • qRangeobject
    Show qRange properties
    • qMinnumber

      Lowest value in the range

      format = double

    • qMaxnumber

      Highest value in the range

      format = double

    • qMinInclEqboolean

      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.

    • qMaxInclEqboolean

      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.
  • qDimIxinteger

    Dimension index.

    format = int32

schemas NxCurrentSelectionItem object

Properties

  • qTotalinteger

    Number of values in the field.

    format = int32

  • qIsNumboolean

    This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional.

  • qFieldstring

    Name of the field that is selected.

  • qLockedboolean

    This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional.

  • qOneAndOnlyOneboolean

    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.

  • qTextSearchstring

    Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional.

  • qSelectedCountinteger

    Number of values that are selected.

    format = int32

  • qSelectedstring

    Values that are selected.

  • qRangeInfoarray of objects

    Information about the range of selected values. Is empty if there is no range of selected values.

    Show qRangeInfo properties
    • qRangeLonumber

      Lowest value in the range.

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

    • qRangeHinumber

      Highest value in the range.

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

    • qMeasurestring

      Label of the measure.
  • qSortIndexinteger

    Sort index of the field. Indexing starts from 0.

    format = int32

  • qStateCountsobject
    Show qStateCounts properties
    • qLockedinteger

      Number of values in locked state.

      format = int32

    • qSelectedinteger

      Number of values in selected state.

      format = int32

    • qOptioninteger

      Number of values in optional state.

      format = int32

    • qDeselectedinteger

      Number of values in deselected state.

      format = int32

    • qAlternativeinteger

      Number of values in alternative state.

      format = int32

    • qExcludedinteger

      Number of values in excluded state.

      format = int32

    • qSelectedExcludedinteger

      Number of values in selected excluded state.

      format = int32

    • qLockedExcludedinteger

      Number of values in locked excluded state.

      format = int32

  • qSelectedFieldSelectionInfoarray of objects

    Information about the fields that are selected.

    Show qSelectedFieldSelectionInfo properties
    • qNamestring

      Name of the field.

    • qFieldSelectionModestring

      Can be one of: "NORMAL""AND""NOT"

  • qNotSelectedFieldSelectionInfoarray of objects

    Information about the fields that are not selected.

    Show qNotSelectedFieldSelectionInfo properties
    • qNamestring

      Name of the field.

    • qFieldSelectionModestring

      Can be one of: "NORMAL""AND""NOT"

  • qSelectionThresholdinteger

    Maximum values to show in the current selections. The default value is 6.

    format = int32

  • qReadableNamestring

    Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly.

  • qIsHiddenboolean

    Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden.

  • qDimensionReferencesarray of objects
    Experimental

    List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem.

    Show qDimensionReferences properties
    • qIdstring

      Identifier of the associated dimension.

    • qLabelstring

      Text label.

schemas NxDataAreaPage object

Properties

  • qLeftnumber

    Position from the left. Corresponds to the lowest possible value of the first measure (the measure on the x-axis).

    format = double

  • qTopnumber

    Position from the top. Corresponds to the highest possible value of the second measure (the measure on the y-axis).

    format = double

  • qWidthnumber

    Width of the page. Corresponds to the highest possible value of the first measure (the measure on the x-axis).

    format = double

  • qHeightnumber

    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

  • qMatrixarray of arrays

    Array of data.

    Show qMatrix properties
    • qTextstring

      Some text. This parameter is optional.

    • qNumnumber

      A value. This parameter is optional.

      format = double

    • qElemNumberinteger

      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

    • qStatestring

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qIsEmptyboolean

      Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

    • qIsTotalCellboolean

      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.

    • qIsOtherCellboolean

      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.

    • qFrequencystring

      Frequency of the value. This parameter is optional.

    • qHighlightRangesobject
      Show qHighlightRanges properties
      • qRangesarray of objects

        Ranges of highlighted values.

        Show qRanges properties
        • qCharPosinteger

          Position of the first search occurrence.

          format = int32

        • qCharCountinteger

          Number of occurrences found.

          format = int32

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

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

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

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

        • qElemNointeger

          Element number.

          format = int32

    • qIsNullboolean

      Is set to true if the value is Null.

    • qMiniChartobject
      Show qMiniChart properties
      • qMatrixarray of arrays

        Array of data.

        Show qMatrix properties
        • qTextstring

          Some text.

        • qNumnumber

          A value. This parameter is optional.

          format = double

        • qElemNumberinteger

          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

        • qAttrExpsobject
          Show qAttrExps properties
          • qValuesarray of objects

            List of attribute expressions values.

            Show qValues properties
            • qTextstring

              Text related to the attribute expression value.

            • qNumnumber

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

              format = double

      • qMinnumber

        format = double

      • qMaxnumber

        format = double

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
    • qInExtRowboolean
  • qTailsarray 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
    • qUpinteger

      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

    • qDowninteger

      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

  • qAreaobject
    Show qArea properties
    • qLeftinteger

      Position from the left. Corresponds to the first column.

      format = int32

    • qTopinteger

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidthinteger

      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

    • qHeightinteger

      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

  • qIsReducedboolean

    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

  • qIdstring

    Identifier of the derived field. The identifier is unique.

  • qNamestring

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

  • qMethodstring

    Method name associated to the derived field.

  • qExprstring

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

  • qTagsarray of strings

    List of tags.

schemas NxDerivedFieldDescriptionList object

Properties

  • qDerivedFieldListsarray of objects

    Information about the derived fields.

    Show qDerivedFieldLists properties
    • qDerivedDefinitionNamestring

      Name of the derived definition.

    • qFieldDefsarray of objects

      List of the derived fields.

      Show qFieldDefs properties
      • qIdstring

        Identifier of the derived field. The identifier is unique.

      • qNamestring

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

      • qMethodstring

        Method name associated to the derived field.

      • qExprstring

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

      • qTagsarray of strings

        List of tags.
    • qGroupDefsarray of objects

      List of the derived groups.

      Show qGroupDefs properties
      • qIdstring

        Identifier of the group.

      • qNamestring

        Name of the derived group.

      • qGroupingstring

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

      • qFieldDefsarray of strings

        List of the derived fields in the group.
    • qTagsarray of strings

      List of tags on the derived fields.

schemas NxDerivedFieldsData object

Properties

  • qDerivedDefinitionNamestring

    Name of the derived definition.

  • qFieldDefsarray of objects

    List of the derived fields.

    Show qFieldDefs properties
    • qIdstring

      Identifier of the derived field. The identifier is unique.

    • qNamestring

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

    • qMethodstring

      Method name associated to the derived field.

    • qExprstring

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

    • qTagsarray of strings

      List of tags.
  • qGroupDefsarray of objects

    List of the derived groups.

    Show qGroupDefs properties
    • qIdstring

      Identifier of the group.

    • qNamestring

      Name of the derived group.

    • qGroupingstring

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

    • qFieldDefsarray of strings

      List of the derived fields in the group.
  • qTagsarray of strings

    List of tags on the derived fields.

schemas NxDerivedGroup object

Properties

  • qIdstring

    Identifier of the group.

  • qNamestring

    Name of the derived group.

  • qGroupingstring

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

  • qFieldDefsarray 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

  • qLibraryIdstring

    Refers to a dimension stored in the library.

  • qDefobject
    Show qDef properties
    • qGroupingstring

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

    • qFieldDefsarray of strings

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

    • qFieldLabelsarray of strings

      Array of field labels. This parameter is optional.

    • qSortCriteriasarray of objects

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

      Show qSortCriterias properties
      • qSortByStateinteger

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

        format = int8

      • qSortByFrequencyinteger

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

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qNumberPresentationsarray of objects

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

      Show qNumberPresentations properties
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

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

    • qActiveFieldinteger

      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

    • qLabelExpressionstring

      Label expression. This parameter is optional.

    • qAliasstring

      Alias of the dimension.
  • qNullSuppressionboolean

    If set to true, no null values are returned.

  • qIncludeElemValueboolean
  • qOtherTotalSpecobject
    Show qOtherTotalSpec properties
    • qOtherModestring

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

    • qOtherCountedobject
      Show qOtherCounted properties
      • qvstring

        Expression evaluated to dual.
    • qOtherLimitobject
      Show qOtherLimit properties
      • qvstring

        Expression evaluated to dual.
    • qOtherLimitModestring

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

    • qSuppressOtherboolean

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

      default = false

    • qForceBadValueKeepingboolean

      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

    • qApplyEvenWhenPossiblyWrongResultboolean

      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

    • qGlobalOtherGroupingboolean

      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

    • qOtherCollapseInnerDimensionsboolean

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

      default = false

    • qOtherSortModestring

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

    • qTotalModestring

      Can be one of: "TOTAL_OFF""TOTAL_EXPR"

    • qReferencedExpressionobject
      Show qReferencedExpression properties
      • qvstring

        Expression evaluated to string.
  • qShowTotalboolean
  • qShowAllboolean

    If set to true, all dimension values are shown.

  • qOtherLabelobject
    Show qOtherLabel properties
    • qvstring

      Expression evaluated to string.
  • qTotalLabelobject
    Show qTotalLabel properties
    • qvstring

      Expression evaluated to string.
  • qCalcCondobject
    Show qCalcCond properties
    • qvstring

      Expression evaluated to dual.
  • qAttributeExpressionsarray of objects

    List of attribute expressions.

    Show qAttributeExpressions properties
    • qExpressionstring

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

    • qLibraryIdstring

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

    • qAttributeboolean

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

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

      Label of the attribute expression.

    • qLabelExpressionstring

      Optional expression used for dynamic label.
  • qAttributeDimensionsarray of objects

    List of attribute dimensions.

    Show qAttributeDimensions properties
    • qDefstring

      Expression or field name.

    • qLibraryIdstring

      LibraryId for dimension.

    • qSortByobject
      Show qSortBy properties
      • qSortByStateinteger

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

        format = int8

      • qSortByFrequencyinteger

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

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qAttributeboolean

      If set to true, this attribute will not affect the number of rows in the cube.
  • qCalcConditionobject
    Show qCalcCondition properties
    • qCondobject
      Show qCond properties
      • qvstring

        Expression evaluated to dual.
    • qMsgobject
      Show qMsg properties
      • qvstring

        Expression evaluated to string.

schemas NxDimensionInfo object

Properties

  • qFallbackTitlestring

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

  • qApprMaxGlyphCountinteger

    Length of the longest value in the field.

    format = int32

  • qCardinalintegerDeprecated

    Number of distinct field values.

    format = int32

  • qLockedboolean

    Is set to true if the field is locked.

  • qSortIndicatorstring

    Can be one of: "N""A""D"

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

  • qGroupPosinteger

    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

  • qStateCountsobject
    Show qStateCounts properties
    • qLockedinteger

      Number of values in locked state.

      format = int32

    • qSelectedinteger

      Number of values in selected state.

      format = int32

    • qOptioninteger

      Number of values in optional state.

      format = int32

    • qDeselectedinteger

      Number of values in deselected state.

      format = int32

    • qAlternativeinteger

      Number of values in alternative state.

      format = int32

    • qExcludedinteger

      Number of values in excluded state.

      format = int32

    • qSelectedExcludedinteger

      Number of values in selected excluded state.

      format = int32

    • qLockedExcludedinteger

      Number of values in locked excluded state.

      format = int32

  • qTagsarray of strings

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

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.
  • qDimensionTypestring

    Can be one of: "D""N""T"

  • qReverseSortboolean

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

  • qGroupingstring

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

  • qIsSemanticboolean

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

  • qNumFormatobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

    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.

  • qGroupFieldDefsarray of strings

    Array of field names.

  • qMinnumber

    Minimum value.

    format = double

  • qMaxnumber

    Maximum value.

    format = double

  • qContinuousAxesboolean

    Is continuous axis used.

  • qIsCyclicboolean

    Is a cyclic dimension used.

  • qDerivedFieldboolean

    Is derived field is used as a dimension.

  • qAttrExprInfoarray of objects

    Array of attribute expressions.

    Show qAttrExprInfo properties
    • qMinnumber

      Minimum value.

      format = double

    • qMaxnumber

      Maximum value.

      format = double

    • qFallbackTitlestring
    • qMinTextstring

      String version of the minimum Value.

    • qMaxTextstring

      String version of the maximum Value.

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

      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.
  • qAttrDimInfoarray of objects

    Array of attribute dimensions.

    Show qAttrDimInfo properties
    • qCardinalinteger

      Cardinality of the attribute expression.

      format = int32

    • qSizeobject
      Show qSize properties
      • qcxinteger

        Number of pixels on the x axis.

        format = int32

      • qcyinteger

        Number of pixels on the y axis.

        format = int32

    • qFallbackTitlestring

      The title for the attribute dimension.

    • qLockedboolean

      The Locked value of the dimension.

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qIsCalculatedboolean

      True if this is a calculated dimension.

      default = false

  • qCalcCondMsgstring

    The message displayed if calculation condition is not fulfilled.

  • qIsCalculatedboolean

    True if this is a calculated dimension.

    default = false

  • qIsOneAndOnlyOneboolean

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

  • qCardinalitiesobject
    Show qCardinalities properties
    • qCardinalinteger

      Number of distinct field values.

      format = int32

    • qHypercubeCardinalinteger

      Number of distinct hypercube values.

      format = int32

    • qAllValuesCardinalinteger

      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

  • qLibraryIdstring

    Refers to a dimension stored in the library.

schemas NxDimensionType string

oneOf

  • D

    NX_DIMENSION_TYPE_DISCRETE

  • N

    NX_DIMENSION_TYPE_NUMERIC

  • T

    NX_DIMENSION_TYPE_TIME

schemas NxDownloadInfo object

Properties

  • qUrlstring

    URL to download the reduced app on.

  • qFileSizeinteger

    The filesize of the reduced app.

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

schemas NxDownloadOptions object

Properties

  • qBookmarkIdstring

    Bookmark Id to apply before reducing the application.

  • qExpiresinteger

    Time in seconds for how long the download link is valid.

    default = 3600, format = int32, default = 3600

  • qServeOnceboolean

    default = false

schemas NxEngineVersion object

Properties

  • qComponentVersionstring

    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

  • qIsSemanticboolean

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

  • qIsHiddenboolean

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

  • qIsSystemboolean

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

  • qAndModeboolean

    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.

  • qNamestring

    Name of the field

  • qCardinalinteger

    Number of distinct field values

    format = int32

  • qTagsarray of strings

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

  • qIsDefinitionOnlyboolean

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

  • qDerivedFieldDataobject
    Show qDerivedFieldData properties
    • qDerivedFieldListsarray of objects

      Information about the derived fields.

      Show qDerivedFieldLists properties
      • qDerivedDefinitionNamestring

        Name of the derived definition.

      • qFieldDefsarray of objects

        List of the derived fields.

        Show qFieldDefs properties
        • qIdstring

          Identifier of the derived field. The identifier is unique.

        • qNamestring

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

        • qMethodstring

          Method name associated to the derived field.

        • qExprstring

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

        • qTagsarray of strings

          List of tags.
      • qGroupDefsarray of objects

        List of the derived groups.

        Show qGroupDefs properties
        • qIdstring

          Identifier of the group.

        • qNamestring

          Name of the derived group.

        • qGroupingstring

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

        • qFieldDefsarray of strings

          List of the derived fields in the group.
      • qTagsarray of strings

        List of tags on the derived fields.
  • qIsDetailboolean

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

  • qIsImplicitboolean

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

  • qReadableNamestring

schemas NxFieldProperties object

Properties

  • qOneAndOnlyOneboolean

    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

  • qNamestring

    Name of the field to get the resource id for.

  • qResourceIdsarray of objects

    Field level resource Id per table that the field is part of

    Show qResourceIds properties
    • qTablestring

      Name of the table that the field belongs to get the resource id for

    • qResourceIdstring

      Resource identifier for the field

schemas NxFieldSelectionInfo object

Properties

  • qNamestring

    Name of the field.

  • qFieldSelectionModestring

    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

  • qTablestring

    Name of the table that the field belongs to get the resource id for

  • qResourceIdstring

    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

  • qTypesarray of strings

    List of object types.

  • qDataobject

    Contains dynamic JSON data specified by the client.

  • qIncludePatchesboolean

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

schemas NxGetObjectOptions object

Properties

  • qTypesarray of strings

    List of object types.

  • qIncludeSessionObjectsboolean

    Set to true to include session objects. The default value is false.

    default = false

  • qDataobject

    Contains dynamic JSON data specified by the client.

schemas NxGroupTail object

Properties

  • qUpinteger

    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

  • qDowninteger

    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

  • qRangesarray of objects

    Ranges of highlighted values.

    Show qRanges properties
    • qCharPosinteger

      Position of the first search occurrence.

      format = int32

    • qCharCountinteger

      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

  • qIdstring

    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.

  • qTypestring

    Type of the object. This parameter is mandatory.

schemas NxInlineDimensionDef object

Properties

  • qGroupingstring

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

  • qFieldDefsarray of strings

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

  • qFieldLabelsarray of strings

    Array of field labels. This parameter is optional.

  • qSortCriteriasarray of objects

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

    Show qSortCriterias properties
    • qSortByStateinteger

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

      format = int8

    • qSortByFrequencyinteger

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

      format = int8

    • qSortByNumericinteger

      Sorts the field values by numeric value.

      format = int8

    • qSortByAsciiinteger

      Sorts the field by alphabetical order.

      format = int8

    • qSortByLoadOrderinteger

      Sorts the field values by the initial load order.

      format = int8

    • qSortByExpressioninteger

      Sorts the field by expression.

      format = int8

    • qExpressionobject
      Show qExpression properties
      • qvstring

        Expression evaluated to dual.
    • qSortByGreynessinteger

      format = int8

  • qNumberPresentationsarray of objects

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

    Show qNumberPresentations properties
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

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

  • qActiveFieldinteger

    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

  • qLabelExpressionstring

    Label expression. This parameter is optional.

  • qAliasstring

    Alias of the dimension.

schemas NxInlineMeasureDef object

Properties

  • qLabelstring

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

  • qDescriptionstring

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

  • qTagsarray of strings

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

  • qGroupingstring

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

  • qDefstring

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

  • qNumFormatobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

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

  • qBrutalSumboolean

    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 .

  • qAggrFuncstring

    Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

  • qAccumulateinteger
    • 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

  • qReverseSortboolean

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

  • qActiveExpressioninteger

    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

  • qExpressionsarray 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.

  • qLabelExpressionstring

    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

  • qErrorCodeinteger

    Error code.

    format = int32

schemas NxLibraryDimension object

Properties

  • qGroupingstring

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

  • qFieldDefsarray of strings

    Array of dimension names.

  • qFieldLabelsarray of strings

    Array of dimension labels.

  • qLabelExpressionstring
  • qAliasstring

    Alias of the dimension.

schemas NxLibraryDimensionDef object

Properties

  • qGroupingstring

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

  • qFieldDefsarray of strings

    Array of dimension names.

  • qFieldLabelsarray of strings

    Array of dimension labels.

  • qLabelExpressionstring
  • qAliasstring

    Alias of the dimension.

schemas NxLibraryMeasure object

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

Properties

  • qLabelstring
  • qDefstring
  • qGroupingstring

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

  • qExpressionsarray of strings
  • qActiveExpressioninteger

    format = int32

  • qLabelExpressionstring
  • qNumFormatobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

schemas NxLibraryMeasureDef object

Properties

  • qLabelstring

    Label of the measure.

  • qDefstring

    Definition of the measure.

  • qGroupingstring

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

  • qExpressionsarray of strings

    Array of expressions.

  • qActiveExpressioninteger

    Index to the active expression in a measure.

    format = int32

  • qLabelExpressionstring

    Optional expression used for dynamic label.

  • qNumFormatobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

schemas NxLinkedObjectInfo object

Properties

  • qRootIdstring

    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.

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

      Type of the object. This parameter is mandatory.

schemas NxListObjectExpression object

Properties

  • qExprstring

    Value of the expression.

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code.

      format = int32

schemas NxListObjectExpressionDef object

Properties

  • qExprstring

    Value of the expression.

  • qLibraryIdstring

    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_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_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_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_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_JSON_RPC_INVALID_REQUEST

  • LOCERR_JSON_RPC_METHOD_NOT_FOUND

  • LOCERR_JSON_RPC_INVALID_PARAMETERS

  • LOCERR_JSON_RPC_INTERNAL_ERROR

  • 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

  • qNamestring

    Name of the field.

  • qTagsarray 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

  • qLibraryIdstring

    Refers to a measure stored in the library.

  • qDefobject
    Show qDef properties
    • qLabelstring

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

    • qDescriptionstring

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

    • qTagsarray of strings

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

    • qGroupingstring

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

    • qDefstring

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

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

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

    • qBrutalSumboolean

      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 .

    • qAggrFuncstring

      Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

    • qAccumulateinteger
      • 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

    • qReverseSortboolean

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

    • qActiveExpressioninteger

      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

    • qExpressionsarray 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.

    • qLabelExpressionstring

      Label expression. This parameter is optional.
  • qSortByobject
    Show qSortBy properties
    • qSortByStateinteger

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

      format = int8

    • qSortByFrequencyinteger

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

      format = int8

    • qSortByNumericinteger

      Sorts the field values by numeric value.

      format = int8

    • qSortByAsciiinteger

      Sorts the field by alphabetical order.

      format = int8

    • qSortByLoadOrderinteger

      Sorts the field values by the initial load order.

      format = int8

    • qSortByExpressioninteger

      Sorts the field by expression.

      format = int8

    • qExpressionobject
      Show qExpression properties
      • qvstring

        Expression evaluated to dual.
    • qSortByGreynessinteger

      format = int8

  • qAttributeExpressionsarray of objects

    List of attribute expressions.

    Show qAttributeExpressions properties
    • qExpressionstring

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

    • qLibraryIdstring

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

    • qAttributeboolean

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

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

      Label of the attribute expression.

    • qLabelExpressionstring

      Optional expression used for dynamic label.
  • qAttributeDimensionsarray of objects

    List of attribute dimensions.

    Show qAttributeDimensions properties
    • qDefstring

      Expression or field name.

    • qLibraryIdstring

      LibraryId for dimension.

    • qSortByobject
      Show qSortBy properties
      • qSortByStateinteger

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

        format = int8

      • qSortByFrequencyinteger

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

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qAttributeboolean

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

      Expression evaluated to dual.
  • qCalcConditionobject
    Show qCalcCondition properties
    • qCondobject
      Show qCond properties
      • qvstring

        Expression evaluated to dual.
    • qMsgobject
      Show qMsg properties
      • qvstring

        Expression evaluated to string.
  • qTrendLinesarray of objects
    Experimental

    Specifies trendlines for this measure.

    Show qTrendLines properties
    • qTypestring

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

    • qXColIxinteger

      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

    • qCalcR2boolean

      Set to true to calulatate the R2 score

      default = false

    • qContinuousXAxisstring

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

    • qMultiDimModestring

      Can be one of: "Multi""Sum"

  • qMiniChartDefobject
    Show qMiniChartDef properties
    • qDefstring

      Expression or field name.

    • qLibraryIdstring

      LibraryId for dimension.

    • qSortByobject
      Show qSortBy properties
      • qSortByStateinteger

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

        format = int8

      • qSortByFrequencyinteger

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

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qOtherTotalSpecobject
      Show qOtherTotalSpec properties
      • qOtherModestring

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

      • qOtherCountedobject
        Show qOtherCounted properties
        • qvstring

          Expression evaluated to dual.
      • qOtherLimitobject
        Show qOtherLimit properties
        • qvstring

          Expression evaluated to dual.
      • qOtherLimitModestring

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

      • qSuppressOtherboolean

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

        default = false

      • qForceBadValueKeepingboolean

        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

      • qApplyEvenWhenPossiblyWrongResultboolean

        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

      • qGlobalOtherGroupingboolean

        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

      • qOtherCollapseInnerDimensionsboolean

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

        default = false

      • qOtherSortModestring

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

      • qTotalModestring

        Can be one of: "TOTAL_OFF""TOTAL_EXPR"

      • qReferencedExpressionobject
        Show qReferencedExpression properties
        • qvstring

          Expression evaluated to string.
    • qMaxNumberPointsinteger

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

    • qAttributeExpressionsarray of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpressionstring

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

      • qLibraryIdstring

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

      • qAttributeboolean

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

      • qNumFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        Label of the attribute expression.

      • qLabelExpressionstring

        Optional expression used for dynamic label.
    • qNullSuppressionboolean

      If set to true, no null values are returned.

schemas NxMeasureInfo object

Layout for NxInlineMeasureDef.

Properties

  • qFallbackTitlestring

    Corresponds to the label of the measure. If the label is not defined then the measure name is used.

  • qApprMaxGlyphCountinteger

    Length of the longest value in the field.

    format = int32

  • qCardinalinteger

    Number of distinct field values.

    format = int32

  • qSortIndicatorstring

    Can be one of: "N""A""D"

  • qNumFormatobject

    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
    • qTypestring

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

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

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

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

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

    Lowest value in the range.

    format = double

  • qMaxnumber

    Highest value in the range.

    format = double

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.
  • qReverseSortboolean

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

  • qIsAutoFormatboolean

    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.

  • qAttrExprInfoarray of objects

    List of attribute expressions.

    Show qAttrExprInfo properties
    • qMinnumber

      Minimum value.

      format = double

    • qMaxnumber

      Maximum value.

      format = double

    • qFallbackTitlestring
    • qMinTextstring

      String version of the minimum Value.

    • qMaxTextstring

      String version of the maximum Value.

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

      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.
  • qAttrDimInfoarray of objects

    List of attribute dimensions.

    Show qAttrDimInfo properties
    • qCardinalinteger

      Cardinality of the attribute expression.

      format = int32

    • qSizeobject
      Show qSize properties
      • qcxinteger

        Number of pixels on the x axis.

        format = int32

      • qcyinteger

        Number of pixels on the y axis.

        format = int32

    • qFallbackTitlestring

      The title for the attribute dimension.

    • qLockedboolean

      The Locked value of the dimension.

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qIsCalculatedboolean

      True if this is a calculated dimension.

      default = false

  • qCalcCondMsgstring

    The message displayed if calculation condition is not fulfilled.

  • qLibraryIdstring

    Refers to a dimension stored in the library.

  • qTrendLinesarray of objects
    Experimental

    Calculated trendlines

    Show qTrendLines properties
    • qTypestring

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

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qCoeffarray of numbers

      Coefficent c0..cN depending on the trendline type.

    • qR2number

      R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

      format = double

    • qExpressionstring

      Trendline expression

    • qElemNointeger

      Inner Dim elem no

      format = int32

  • qMiniChartobject
    Show qMiniChart properties
    • qYMinnumber

      format = double

    • qYMaxnumber

      format = double

    • qXMinnumber

      format = double

    • qXMaxnumber

      format = double

    • qAttrExprInfoarray of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMinnumber

        Minimum value.

        format = double

      • qMaxnumber

        Maximum value.

        format = double

      • qFallbackTitlestring
      • qMinTextstring

        String version of the minimum Value.

      • qMaxTextstring

        String version of the maximum Value.

      • qNumFormatobject

        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
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        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.
    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.

schemas NxMeta object

Layout for NxMetaDef.

Properties

  • qNamestring

    Name. This property is optional.

schemas NxMetaDef object

Used to collect meta data.

Properties

Semantic type with an empty structure.

schemas NxMiniChart object

Properties

  • qYMinnumber

    format = double

  • qYMaxnumber

    format = double

  • qXMinnumber

    format = double

  • qXMaxnumber

    format = double

  • qAttrExprInfoarray of objects

    List of attribute expressions.

    Show qAttrExprInfo properties
    • qMinnumber

      Minimum value.

      format = double

    • qMaxnumber

      Maximum value.

      format = double

    • qFallbackTitlestring
    • qMinTextstring

      String version of the minimum Value.

    • qMaxTextstring

      String version of the maximum Value.

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

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

      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.
  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.

schemas NxMiniChartCell object

Properties

  • qTextstring

    Some text.

  • qNumnumber

    A value. This parameter is optional.

    format = double

  • qElemNumberinteger

    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

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

        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

  • qMatrixarray of arrays

    Array of data.

    Show qMatrix properties
    • qTextstring

      Some text.

    • qNumnumber

      A value. This parameter is optional.

      format = double

    • qElemNumberinteger

      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

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

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

          format = double

  • qMinnumber

    format = double

  • qMaxnumber

    format = double

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.

schemas NxMiniChartDef object

Properties

  • qDefstring

    Expression or field name.

  • qLibraryIdstring

    LibraryId for dimension.

  • qSortByobject
    Show qSortBy properties
    • qSortByStateinteger

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

      format = int8

    • qSortByFrequencyinteger

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

      format = int8

    • qSortByNumericinteger

      Sorts the field values by numeric value.

      format = int8

    • qSortByAsciiinteger

      Sorts the field by alphabetical order.

      format = int8

    • qSortByLoadOrderinteger

      Sorts the field values by the initial load order.

      format = int8

    • qSortByExpressioninteger

      Sorts the field by expression.

      format = int8

    • qExpressionobject
      Show qExpression properties
      • qvstring

        Expression evaluated to dual.
    • qSortByGreynessinteger

      format = int8

  • qOtherTotalSpecobject
    Show qOtherTotalSpec properties
    • qOtherModestring

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

    • qOtherCountedobject
      Show qOtherCounted properties
      • qvstring

        Expression evaluated to dual.
    • qOtherLimitobject
      Show qOtherLimit properties
      • qvstring

        Expression evaluated to dual.
    • qOtherLimitModestring

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

    • qSuppressOtherboolean

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

      default = false

    • qForceBadValueKeepingboolean

      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

    • qApplyEvenWhenPossiblyWrongResultboolean

      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

    • qGlobalOtherGroupingboolean

      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

    • qOtherCollapseInnerDimensionsboolean

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

      default = false

    • qOtherSortModestring

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

    • qTotalModestring

      Can be one of: "TOTAL_OFF""TOTAL_EXPR"

    • qReferencedExpressionobject
      Show qReferencedExpression properties
      • qvstring

        Expression evaluated to string.
  • qMaxNumberPointsinteger

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

  • qAttributeExpressionsarray of objects

    List of attribute expressions.

    Show qAttributeExpressions properties
    • qExpressionstring

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

    • qLibraryIdstring

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

    • qAttributeboolean

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

    • qNumFormatobject

      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
      • qTypestring

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

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

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

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qLabelstring

      Label of the attribute expression.

    • qLabelExpressionstring

      Optional expression used for dynamic label.
  • qNullSuppressionboolean

    If set to true, no null values are returned.

schemas NxMiniChartRows object[]

Element properties

  • qTextstring

    Some text.

  • qNumnumber

    A value. This parameter is optional.

    format = double

  • qElemNumberinteger

    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

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

        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

  • qRangesarray of objects
    Show qRanges properties
    • qRangeobject
      Show qRange properties
      • qMinnumber

        Lowest value in the range

        format = double

      • qMaxnumber

        Highest value in the range

        format = double

      • qMinInclEqboolean

        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.

      • qMaxInclEqboolean

        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.
    • qMeasureIxinteger

      Number of the measure to select. Numbering starts from 0.

      format = int32

  • qColumnsToSelectarray of integers

schemas NxPage object

Properties

  • qLeftinteger

    Position from the left. Corresponds to the first column.

    format = int32

  • qTopinteger

    Position from the top. Corresponds to the first row.

    format = int32

  • qWidthinteger

    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

  • qHeightinteger

    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

  • qLeftinteger

    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

  • qDepthinteger

    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

  • qAreaobject
    Show qArea properties
    • qLeftinteger

      Position from the left. Corresponds to the first column.

      format = int32

    • qTopinteger

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidthinteger

      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

    • qHeightinteger

      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

  • qAllValuesboolean

    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

  • qOpstring

    Can be one of: "add""remove""replace"

  • qPathstring

    Path to the property to add, remove or replace.

  • qValuestring

    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

  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

      Type of the object. This parameter is mandatory.
  • qPatchesarray of objects

    Array with patches.

    Show qPatches properties
    • qOpstring

      Can be one of: "add""remove""replace"

    • qPathstring

      Path to the property to add, remove or replace.

    • qValuestring

      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""
  • qChildrenarray of objects

    Array with child objects and their patches.

    Show qChildren properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qPatchesarray of objects

      Array with patches.

      Show qPatches properties
      • qOpstring

        Can be one of: "add""remove""replace"

      • qPathstring

        Path to the property to add, remove or replace.

      • qValuestring

        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""
    • qChildrenarray of undefineds

      Array with child objects and their patches.

schemas NxPivotDimensionCell object

Properties

  • qTextstring

    Some text.

  • qElemNointeger

    Rank number of the value. If set to -1, it means that the value is not an element number.

    format = int32

  • qValuenumber

    Value of the cell. Is set to NaN , if the value is not a number.

    format = double

  • qCanExpandboolean

    If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

  • qCanCollapseboolean

    If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

  • qTypestring

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qUpinteger

    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

  • qDowninteger

    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

  • qSubNodesarray of objects

    Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

    Show qSubNodes properties
    • qTextstring

      Some text.

    • qElemNointeger

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValuenumber

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpandboolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapseboolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qTypestring

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qUpinteger

      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

    • qDowninteger

      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

    • qSubNodesarray of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDimsobject
    Show qAttrDims properties
    • qValuesarray of objects

      List of values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNointeger

        Element number.

        format = int32

schemas NxPivotPage object

Properties

  • qLeftarray of objects

    Information about the left dimension values of a pivot table.

    Show qLeft properties
    • qTextstring

      Some text.

    • qElemNointeger

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValuenumber

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpandboolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapseboolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qTypestring

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qUpinteger

      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

    • qDowninteger

      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

    • qSubNodesarray of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

  • qToparray 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
    • qTextstring

      Some text.

    • qElemNointeger

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValuenumber

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpandboolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapseboolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qTypestring

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qUpinteger

      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

    • qDowninteger

      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

    • qSubNodesarray of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

  • qDataarray of arrays

    Array of data.

    Show qData properties
    • qLabelstring

      Label of the cell. This parameter is optional.

    • qTextstring

      Some text related to the cell.

    • qNumnumber

      Value of the cell.

      format = double

    • qTypestring

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

  • qAreaobject
    Show qArea properties
    • qLeftinteger

      Position from the left. Corresponds to the first column.

      format = int32

    • qTopinteger

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidthinteger

      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

    • qHeightinteger

      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

  • qLabelstring

    Label of the cell. This parameter is optional.

  • qTextstring

    Some text related to the cell.

  • qNumnumber

    Value of the cell.

    format = double

  • qTypestring

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDimsobject
    Show qAttrDims properties
    • qValuesarray of objects

      List of values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNointeger

        Element number.

        format = int32

schemas NxRange object

Properties

  • qFrominteger

    Position in the expression of the first character of the field name.

    format = int32

  • qCountinteger

    Number of characters in the field name.

    format = int32

schemas NxRangeSelectInfo object

Properties

  • qRangeobject
    Show qRange properties
    • qMinnumber

      Lowest value in the range

      format = double

    • qMaxnumber

      Highest value in the range

      format = double

    • qMinInclEqboolean

      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.

    • qMaxInclEqboolean

      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.
  • qMeasureIxinteger

    Number of the measure to select. Numbering starts from 0.

    format = int32

schemas NxSelectionCell object

Properties

  • qTypestring

    Can be one of: "D""T""L"

  • qColinteger

    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

  • qRowinteger

    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

  • qInSelectionsboolean

    Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections Method.

  • qMadeSelectionsboolean

    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

  • qTextstring

    Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

  • qElemNointeger

    Element number.

    format = int32

schemas NxSimpleValue object

Properties

  • qTextstring

    Text related to the attribute expression value.

  • qNumnumber

    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

  • qDataarray of objects

    Array of data.

    Show qData properties
    • qTextstring

      Some text.

    • qElemNointeger

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValuenumber

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpandboolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapseboolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qTypestring

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qMaxPosnumber

      Total of the positive values in the current group of cells.

      format = double

    • qMinNegnumber

      Total of the negative values in the current group of cells.

      format = double

    • qUpinteger

      Number of elements that are part of the previous tail.

      format = int32

    • qDowninteger

      Number of elements that are part of the next tail.

      format = int32

    • qRowinteger

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qSubNodesarray of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

  • qAreaobject
    Show qArea properties
    • qLeftinteger

      Position from the left. Corresponds to the first column.

      format = int32

    • qTopinteger

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidthinteger

      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

    • qHeightinteger

      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

  • qTextstring

    Some text.

  • qElemNointeger

    Rank number of the value. If set to -1, it means that the value is not an element number.

    format = int32

  • qValuenumber

    Value of the cell. Is set to NaN , if the value is not a number.

    format = double

  • qCanExpandboolean

    If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

  • qCanCollapseboolean

    If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

  • qTypestring

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qMaxPosnumber

    Total of the positive values in the current group of cells.

    format = double

  • qMinNegnumber

    Total of the negative values in the current group of cells.

    format = double

  • qUpinteger

    Number of elements that are part of the previous tail.

    format = int32

  • qDowninteger

    Number of elements that are part of the next tail.

    format = int32

  • qRowinteger

    Row index in the data matrix. The indexing starts from 0.

    format = int32

  • qSubNodesarray of objects

    Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

    Show qSubNodes properties
    • qTextstring

      Some text.

    • qElemNointeger

      Rank number of the value. If set to -1, it means that the value is not an element number.

      format = int32

    • qValuenumber

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qCanExpandboolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapseboolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qTypestring

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qMaxPosnumber

      Total of the positive values in the current group of cells.

      format = double

    • qMinNegnumber

      Total of the negative values in the current group of cells.

      format = double

    • qUpinteger

      Number of elements that are part of the previous tail.

      format = int32

    • qDowninteger

      Number of elements that are part of the next tail.

      format = int32

    • qRowinteger

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qSubNodesarray of undefineds

      Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDimsobject
    Show qAttrDims properties
    • qValuesarray of objects

      List of values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNointeger

        Element number.

        format = int32

schemas NxStateCounts object

Properties

  • qLockedinteger

    Number of values in locked state.

    format = int32

  • qSelectedinteger

    Number of values in selected state.

    format = int32

  • qOptioninteger

    Number of values in optional state.

    format = int32

  • qDeselectedinteger

    Number of values in deselected state.

    format = int32

  • qAlternativeinteger

    Number of values in alternative state.

    format = int32

  • qExcludedinteger

    Number of values in excluded state.

    format = int32

  • qSelectedExcludedinteger

    Number of values in selected excluded state.

    format = int32

  • qLockedExcludedinteger

    Number of values in locked excluded state.

    format = int32

schemas NxStreamListEntry object

Deprecated
This struct is deprecated (not recommended to use).

Properties

  • qNamestring

    Name of the stream.

  • qIdstring

    Identifier of the stream.

schemas NxTempBookmarkOptions object

Properties

  • qIncludeVariablesboolean

    IncludeVariables If true all variables will be stored in the temporary bookmark

  • qIncludeAllPatchesboolean

    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

  • qTextstring

    Tick's label.

  • qStartnumber

    Start value.

    format = double

  • qEndnumber

    End value.

    format = double

schemas NxTreeDataOption object

Specifies all the paging filters needed to define the tree to be fetched.

Properties

  • qMaxNbrOfNodesinteger

    Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

    format = int32

  • qTreeNodesarray of objects

    Defines areas of the tree to be fetched. Areas must be defined left to right.

    Show qTreeNodes properties
    • qAreaobject
      Show qArea properties
      • qLeftinteger

        Position from the left. Corresponds to the first column.

        format = int32

      • qTopinteger

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidthinteger

        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

      • qHeightinteger

        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

    • qAllValuesboolean

      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.
  • qTreeLevelsobject
    Show qTreeLevels properties
    • qLeftinteger

      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

    • qDepthinteger

      Number of dimensions to include in the tree.

      default = -1, format = int32, default = -1

schemas NxTreeDimensionDef object

Properties

  • qLibraryIdstring

    Refers to a dimension stored in the library.

  • qDefobject
    Show qDef properties
    • qGroupingstring

      Can be one of: "N""H""C"

    • qFieldDefsarray of strings

      Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

    • qFieldLabelsarray of strings

      Array of field labels. This parameter is optional.

    • qSortCriteriasarray of objects

      Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

      Show qSortCriterias properties
      • qSortByStateinteger

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequencyinteger

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qNumberPresentationsarray of objects

      Defines the format of the value. This parameter is optional.

      Show qNumberPresentations properties
      • qTypestring

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qReverseSortboolean

      If set to true, it inverts the sort criteria in the field.

    • qActiveFieldinteger

      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

    • qLabelExpressionstring

      Label expression. This parameter is optional.

    • qAliasstring

      Alias of the dimension.
  • qValueExprsarray of objects

    List of measures.

    Show qValueExprs properties
    • qLibraryIdstring

      Refers to a measure stored in the library.

    • qDefobject
      Show qDef properties
      • qLabelstring

        Name of the measure. An empty string is returned as a default value. This parameter is optional.

      • qDescriptionstring

        Description of the measure. An empty string is returned as a default value. This parameter is optional.

      • qTagsarray of strings

        Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

      • qGroupingstring

        Can be one of: "N""H""C"

      • qDefstring

        Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRelativeboolean

        If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

      • qBrutalSumboolean

        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 .

      • qAggrFuncstring

        Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

      • qAccumulateinteger
        • 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

      • qReverseSortboolean

        If set to true, it inverts the sort criteria in the field.

      • qActiveExpressioninteger

        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

      • qExpressionsarray 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.

      • qLabelExpressionstring

        Label expression. This parameter is optional.
    • qSortByobject
      Show qSortBy properties
      • qSortByStateinteger

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequencyinteger

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qAttributeExpressionsarray of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpressionstring

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryIdstring

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttributeboolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabelstring

        Label of the attribute expression.

      • qLabelExpressionstring

        Optional expression used for dynamic label.
    • qAttributeDimensionsarray of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDefstring

        Expression or field name.

      • qLibraryIdstring

        LibraryId for dimension.

      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequencyinteger

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qAttributeboolean

        If set to true, this attribute will not affect the number of rows in the cube.
    • qCalcCondobject
      Show qCalcCond properties
      • qvstring

        Expression evaluated to dual.
    • qCalcConditionobject
      Show qCalcCondition properties
      • qCondobject
        Show qCond properties
        • qvstring

          Expression evaluated to dual.
      • qMsgobject
        Show qMsg properties
        • qvstring

          Expression evaluated to string.
    • qTrendLinesarray of objects
      Experimental

      Specifies trendlines for this measure.

      Show qTrendLines properties
      • qTypestring

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qXColIxinteger

        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

      • qCalcR2boolean

        Set to true to calulatate the R2 score

        default = false

      • qContinuousXAxisstring

        Can be one of: "Never""Possible""Time"

      • qMultiDimModestring

        Can be one of: "Multi""Sum"

    • qMiniChartDefobject
      Show qMiniChartDef properties
      • qDefstring

        Expression or field name.

      • qLibraryIdstring

        LibraryId for dimension.

      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequencyinteger

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qOtherTotalSpecobject
        Show qOtherTotalSpec properties
        • qOtherModestring

          Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

        • qOtherCountedobject
          Show qOtherCounted properties
          • qvstring

            Expression evaluated to dual.
        • qOtherLimitobject
          Show qOtherLimit properties
          • qvstring

            Expression evaluated to dual.
        • qOtherLimitModestring

          Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

        • qSuppressOtherboolean

          If set to true, the group Others is not displayed as a dimension value. The default value is false.

          default = false

        • qForceBadValueKeepingboolean

          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

        • qApplyEvenWhenPossiblyWrongResultboolean

          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

        • qGlobalOtherGroupingboolean

          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

        • qOtherCollapseInnerDimensionsboolean

          If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

          default = false

        • qOtherSortModestring

          Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

        • qTotalModestring

          Can be one of: "TOTAL_OFF""TOTAL_EXPR"

        • qReferencedExpressionobject
          Show qReferencedExpression properties
          • qvstring

            Expression evaluated to string.
      • qMaxNumberPointsinteger

        default = -1, format = int32, default = -1

      • qAttributeExpressionsarray of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpressionstring

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryIdstring

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttributeboolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormatobject

          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
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabelstring

          Label of the attribute expression.

        • qLabelExpressionstring

          Optional expression used for dynamic label.
      • qNullSuppressionboolean

        If set to true, no null values are returned.
  • qNullSuppressionboolean

    If set to true, no null values are returned.

  • qOtherTotalSpecobject
    Show qOtherTotalSpec properties
    • qOtherModestring

      Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

    • qOtherCountedobject
      Show qOtherCounted properties
      • qvstring

        Expression evaluated to dual.
    • qOtherLimitobject
      Show qOtherLimit properties
      • qvstring

        Expression evaluated to dual.
    • qOtherLimitModestring

      Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

    • qSuppressOtherboolean

      If set to true, the group Others is not displayed as a dimension value. The default value is false.

      default = false

    • qForceBadValueKeepingboolean

      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

    • qApplyEvenWhenPossiblyWrongResultboolean

      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

    • qGlobalOtherGroupingboolean

      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

    • qOtherCollapseInnerDimensionsboolean

      If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

      default = false

    • qOtherSortModestring

      Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

    • qTotalModestring

      Can be one of: "TOTAL_OFF""TOTAL_EXPR"

    • qReferencedExpressionobject
      Show qReferencedExpression properties
      • qvstring

        Expression evaluated to string.
  • qShowAllboolean

    If set to true, all dimension values are shown.

  • qOtherLabelobject
    Show qOtherLabel properties
    • qvstring

      Expression evaluated to string.
  • qTotalLabelobject
    Show qTotalLabel properties
    • qvstring

      Expression evaluated to string.
  • qCalcConditionobject
    Show qCalcCondition properties
    • qCondobject
      Show qCond properties
      • qvstring

        Expression evaluated to dual.
    • qMsgobject
      Show qMsg properties
      • qvstring

        Expression evaluated to string.
  • qAttributeExpressionsarray of objects

    List of attribute expressions.

    Show qAttributeExpressions properties
    • qExpressionstring

      Definition of the attribute expression. Example: "Max(OrderID)"

    • qLibraryIdstring

      Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

    • qAttributeboolean

      If set to true, this measure will not affect the number of rows in the cube.

    • qNumFormatobject

      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
      • qTypestring

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qLabelstring

      Label of the attribute expression.

    • qLabelExpressionstring

      Optional expression used for dynamic label.
  • qAttributeDimensionsarray of objects

    List of attribute dimensions.

    Show qAttributeDimensions properties
    • qDefstring

      Expression or field name.

    • qLibraryIdstring

      LibraryId for dimension.

    • qSortByobject
      Show qSortBy properties
      • qSortByStateinteger

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequencyinteger

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qAttributeboolean

      If set to true, this attribute will not affect the number of rows in the cube.

schemas NxTreeDimensionInfo object

Properties

  • qFallbackTitlestring

    Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used.

  • qApprMaxGlyphCountinteger

    Length of the longest value in the field.

    format = int32

  • qCardinalintegerDeprecated

    Number of distinct field values.

    format = int32

  • qLockedboolean

    Is set to true if the field is locked.

  • qSortIndicatorstring

    Can be one of: "N""A""D"

  • qGroupFallbackTitlesarray 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).

  • qGroupPosinteger

    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

  • qStateCountsobject
    Show qStateCounts properties
    • qLockedinteger

      Number of values in locked state.

      format = int32

    • qSelectedinteger

      Number of values in selected state.

      format = int32

    • qOptioninteger

      Number of values in optional state.

      format = int32

    • qDeselectedinteger

      Number of values in deselected state.

      format = int32

    • qAlternativeinteger

      Number of values in alternative state.

      format = int32

    • qExcludedinteger

      Number of values in excluded state.

      format = int32

    • qSelectedExcludedinteger

      Number of values in selected excluded state.

      format = int32

    • qLockedExcludedinteger

      Number of values in locked excluded state.

      format = int32

  • qTagsarray of strings

    Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.
  • qDimensionTypestring

    Can be one of: "D""N""T"

  • qReverseSortboolean

    If set to true, it inverts the sort criteria in the field.

  • qGroupingstring

    Can be one of: "N""H""C"

  • qIsSemanticboolean

    If set to true, it means that the field is a semantic.

  • qNumFormatobject

    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
    • qTypestring

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qIsAutoFormatboolean

    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.

  • qGroupFieldDefsarray of strings

    Array of field names.

  • qMinnumber

    Minimum value.

    format = double

  • qMaxnumber

    Maximum value.

    format = double

  • qContinuousAxesboolean

    Is continuous axis used.

  • qIsCyclicboolean

    Is a cyclic dimension used.

  • qDerivedFieldboolean

    Is derived field is used as a dimension.

  • qMeasureInfoarray of objects

    A List of measures to be calculated on this TreeDimension.

    Show qMeasureInfo properties
    • qFallbackTitlestring

      Corresponds to the label of the measure. If the label is not defined then the measure name is used.

    • qApprMaxGlyphCountinteger

      Length of the longest value in the field.

      format = int32

    • qCardinalinteger

      Number of distinct field values.

      format = int32

    • qSortIndicatorstring

      Can be one of: "N""A""D"

    • qNumFormatobject

      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
      • qTypestring

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qMinnumber

      Lowest value in the range.

      format = double

    • qMaxnumber

      Highest value in the range.

      format = double

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qReverseSortboolean

      If set to true, it inverts the sort criteria in the field.

    • qIsAutoFormatboolean

      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.

    • qAttrExprInfoarray of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMinnumber

        Minimum value.

        format = double

      • qMaxnumber

        Maximum value.

        format = double

      • qFallbackTitlestring
      • qMinTextstring

        String version of the minimum Value.

      • qMaxTextstring

        String version of the maximum Value.

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qIsAutoFormatboolean

        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.
    • qAttrDimInfoarray of objects

      List of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinalinteger

        Cardinality of the attribute expression.

        format = int32

      • qSizeobject
        Show qSize properties
        • qcxinteger

          Number of pixels on the x axis.

          format = int32

        • qcyinteger

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitlestring

        The title for the attribute dimension.

      • qLockedboolean

        The Locked value of the dimension.

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qIsCalculatedboolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsgstring

      The message displayed if calculation condition is not fulfilled.

    • qLibraryIdstring

      Refers to a dimension stored in the library.

    • qTrendLinesarray of objects
      Experimental

      Calculated trendlines

      Show qTrendLines properties
      • qTypestring

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qCoeffarray of numbers

        Coefficent c0..cN depending on the trendline type.

      • qR2number

        R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

        format = double

      • qExpressionstring

        Trendline expression

      • qElemNointeger

        Inner Dim elem no

        format = int32

    • qMiniChartobject
      Show qMiniChart properties
      • qYMinnumber

        format = double

      • qYMaxnumber

        format = double

      • qXMinnumber

        format = double

      • qXMaxnumber

        format = double

      • qAttrExprInfoarray of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMinnumber

          Minimum value.

          format = double

        • qMaxnumber

          Maximum value.

          format = double

        • qFallbackTitlestring
        • qMinTextstring

          String version of the minimum Value.

        • qMaxTextstring

          String version of the maximum Value.

        • qNumFormatobject

          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
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qIsAutoFormatboolean

          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.
      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
  • qAttrExprInfoarray of objects

    List of attribute expressions.

    Show qAttrExprInfo properties
    • qMinnumber

      Minimum value.

      format = double

    • qMaxnumber

      Maximum value.

      format = double

    • qFallbackTitlestring
    • qMinTextstring

      String version of the minimum Value.

    • qMaxTextstring

      String version of the maximum Value.

    • qNumFormatobject

      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
      • qTypestring

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qIsAutoFormatboolean

      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.
  • qAttrDimInfoarray of objects

    List of attribute dimensions.

    Show qAttrDimInfo properties
    • qCardinalinteger

      Cardinality of the attribute expression.

      format = int32

    • qSizeobject
      Show qSize properties
      • qcxinteger

        Number of pixels on the x axis.

        format = int32

      • qcyinteger

        Number of pixels on the y axis.

        format = int32

    • qFallbackTitlestring

      The title for the attribute dimension.

    • qLockedboolean

      The Locked value of the dimension.

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qIsCalculatedboolean

      True if this is a calculated dimension.

      default = false

  • qCalcCondMsgstring

    The message displayed if calculation condition is not fulfilled.

  • qIsCalculatedboolean

    True if this is a calculated dimension.

    default = false

  • qIsOneAndOnlyOneboolean

    If set to true, it means that the field always has one and only one selected value.

  • qCardinalitiesobject
    Show qCardinalities properties
    • qCardinalinteger

      Number of distinct field values.

      format = int32

    • qHypercubeCardinalinteger

      Number of distinct hypercube values.

      format = int32

    • qAllValuesCardinalinteger

      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

  • qLibraryIdstring

    Refers to a dimension stored in the library.

schemas NxTreeMultiRangeSelectInfo object

Properties

  • qRangesarray of objects

    An array of Ranges.

    Show qRanges properties
    • qRangeobject
      Show qRange properties
      • qMinnumber

        Lowest value in the range

        format = double

      • qMaxnumber

        Highest value in the range

        format = double

      • qMinInclEqboolean

        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.

      • qMaxInclEqboolean

        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.
    • qMeasureIxinteger

      Number of the measure to select. Numbering starts from 0.

      format = int32

    • qDimensionIxinteger

      Number of the dimension to select measure from. Numbering starts from 0.

      format = int32

schemas NxTreeNode object

Represents a dimension in the tree.

Properties

  • qTextstring

    The text version of the value, if available.

  • qValuenumber

    Value of the cell. Is set to NaN , if the value is not a number.

    format = double

  • qElemNointeger

    Element number.

    format = int32

  • qGroupPosinteger

    The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

    format = int32

  • qGroupSizeinteger

    Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

    format = int32

  • qRowinteger

    Row index in the data matrix. The indexing starts from 0.

    format = int32

  • qTypestring

    Can be one of: "V""E""N""T""O""A""P""R""U""G"

  • qValuesarray of objects

    The measures for this node.

    Show qValues properties
    • qTextstring

      The text version of the value, if available.

    • qValuenumber

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

  • qNodesarray of objects

    The children of this node in the fetched tree structure.

    Show qNodes properties
    • qTextstring

      The text version of the value, if available.

    • qValuenumber

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qElemNointeger

      Element number.

      format = int32

    • qGroupPosinteger

      The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

      format = int32

    • qGroupSizeinteger

      Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

      format = int32

    • qRowinteger

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qTypestring

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qValuesarray of objects

      The measures for this node.

      Show qValues properties
      • qTextstring

        The text version of the value, if available.

      • qValuenumber

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDimsobject
        Show qAttrDims properties
        • qValuesarray of objects

          List of values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNointeger

            Element number.

            format = int32

    • qNodesarray of undefineds

      The children of this node in the fetched tree structure.

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

    • qMaxPosarray of numbers

      Total of the positive values in the current group of cells.

    • qMinNegarray of numbers

      Total of the negative values in the current group of cells.

    • qCanExpandboolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapseboolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qStatestring

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qTreePatharray 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.
  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDimsobject
    Show qAttrDims properties
    • qValuesarray of objects

      List of values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNointeger

        Element number.

        format = int32

  • qMaxPosarray of numbers

    Total of the positive values in the current group of cells.

  • qMinNegarray of numbers

    Total of the negative values in the current group of cells.

  • qCanExpandboolean

    If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

  • qCanCollapseboolean

    If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

  • qStatestring

    Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

  • qTreePatharray 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

  • qRangeobject
    Show qRange properties
    • qMinnumber

      Lowest value in the range

      format = double

    • qMaxnumber

      Highest value in the range

      format = double

    • qMinInclEqboolean

      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.

    • qMaxInclEqboolean

      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.
  • qMeasureIxinteger

    Number of the measure to select. Numbering starts from 0.

    format = int32

  • qDimensionIxinteger

    Number of the dimension to select measure from. Numbering starts from 0.

    format = int32

schemas NxTreeValue object

Represents a measure.

Properties

  • qTextstring

    The text version of the value, if available.

  • qValuenumber

    Value of the cell. Is set to NaN , if the value is not a number.

    format = double

  • qAttrExpsobject
    Show qAttrExps properties
    • qValuesarray of objects

      List of attribute expressions values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value.

      • qNumnumber

        Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

        format = double

  • qAttrDimsobject
    Show qAttrDims properties
    • qValuesarray of objects

      List of values.

      Show qValues properties
      • qTextstring

        Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

      • qElemNointeger

        Element number.

        format = int32

schemas NxTrendline object

Experimental

Information about the calculated trendline.

Properties

  • qTypestring

    Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.
  • qCoeffarray of numbers

    Coefficent c0..cN depending on the trendline type.

  • qR2number

    R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

    format = double

  • qExpressionstring

    Trendline expression

  • qElemNointeger

    Inner Dim elem no

    format = int32

schemas NxTrendlineDef object

Experimental

Trendline input definition

Properties

  • qTypestring

    Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

  • qXColIxinteger

    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

  • qCalcR2boolean

    Set to true to calulatate the R2 score

    default = false

  • qContinuousXAxisstring

    Can be one of: "Never""Possible""Time"

  • qMultiDimModestring

    Can be one of: "Multi""Sum"

schemas NxTrendlineMode string

oneOf

  • Multi

    TRENDLINE_MULTILINE

  • Sum

    TRENDLINE_SUM

schemas NxValidationError object

Properties

  • qErrorCodeinteger

    Error code. This parameter is always displayed in case of error.

    format = int32

  • qContextstring

    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.

  • qExtendedMessagestring

    Internal information from the server. This parameter is optional.

schemas NxVariableListItem object

Properties

  • qNamestring

    Name of the variable.

  • qDescriptionstring

    Description of the variable.

  • qDefinitionstring

    Definition of the variable. It can be a value or an expression.

  • qIsConfigboolean

    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

  • qIsReservedboolean

    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

  • qMetaobject

    Layout for NxMetaDef.

    Show qMeta properties
    • qNamestring

      Name. This property is optional.
  • qInfoobject
    Show qInfo properties
    • qIdstring

      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.

    • qTypestring

      Type of the object. This parameter is mandatory.
  • qDataobject

    Contains dynamic JSON data specified by the client.

  • qIsScriptCreatedboolean

    If set to true, it means that the variable was defined via script.

schemas NxVariableProperties object

Deprecated

Properties

  • qNamestring

    Name of the variable.

  • qNumberPresentationobject

    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
    • qTypestring

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qIncludeInBookmarkboolean

    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

  • qUsePredefListedValuesboolean

    The value of a variable can be an enumeration. Set this property to true to reflect the predefined values in an enumeration.

  • qPreDefinedListarray of strings

    List of enumerations. This property is used if qUsePredefListedValues is set to true.

schemas NxViewPort object

Properties

  • qWidthinteger

    Width of the canvas in pixels.

    format = int32

  • qHeightinteger

    Height of the canvas in pixels.

    format = int32

  • qZoomLevelinteger

    Zoom level.

    format = int32

schemas ObjectInterface object

Properties

  • qTypestring

    The native type of the object.

  • qHandleinteger

    The handle used to connect to object.

    format = int32

  • qGenericTypestring

    The type of the object.

  • qGenericIdstring

    Object ID.

schemas OdbcDsn object

Properties

  • qNamestring

    Name of the ODBC connection.

  • qDescriptionstring

    Description of the ODBC connection.

  • qBit32boolean

    Is set to true if the version of ODBC is 32-bit. This parameter is optional. Default is false.

    default = false

  • qUserOnlyboolean

    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

  • qNamestring

    Name of the OLEDB provider.

  • qDescriptionstring

    Description of the OLEDB provider.

  • qBit32boolean

    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

  • qOtherModestring

    Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

  • qOtherCountedobject
    Show qOtherCounted properties
    • qvstring

      Expression evaluated to dual.
  • qOtherLimitobject
    Show qOtherLimit properties
    • qvstring

      Expression evaluated to dual.
  • qOtherLimitModestring

    Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

  • qSuppressOtherboolean

    If set to true, the group Others is not displayed as a dimension value. The default value is false.

    default = false

  • qForceBadValueKeepingboolean

    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

  • qApplyEvenWhenPossiblyWrongResultboolean

    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

  • qGlobalOtherGroupingboolean

    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

  • qOtherCollapseInnerDimensionsboolean

    If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

    default = false

  • qOtherSortModestring

    Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

  • qTotalModestring

    Can be one of: "TOTAL_OFF""TOTAL_EXPR"

  • qReferencedExpressionobject
    Show qReferencedExpression properties
    • qvstring

      Expression evaluated to string.

schemas Point object

Properties

  • qxinteger

    x-coordinate in pixels. The origin is the top left of the screen.

    format = int32

  • qyinteger

    y-coordinate in pixels. The origin is the top left of the screen.

    format = int32

schemas PositionMark object

Properties

  • qDimNamestring
  • qElemNoarray of integers
  • qElemValuesarray of strings

schemas ProgressData object

Properties

  • qStartedboolean

    True if the request is started.

  • qFinishedboolean

    True if the request is finished.

  • qCompletedinteger

    This property is not used.

    format = int64

  • qTotalinteger

    This property is not used.

    format = int64

  • qKBinteger

    This property is not used.

    format = int32

  • qMillisecsinteger

    Request duration in milliseconds.

    format = int32

  • qUserInteractionWantedboolean

    True when the engine pauses the script execution and waits for a user interaction.

  • qPersistentProgressstring

    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).

  • qTransientProgressstring

    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).

  • qErrorDataarray of objects

    Information about the error messages that occur during the script execution.

    Show qErrorData properties
    • qErrorStringstring

      Detailed information about the error message.

    • qLineEndstring

      Line termination characters.

    • qLinestring

      Script statement where the error occurs.

    • qErrorDataCodestring

      Can be one of: "EDC_ERROR""EDC_WARNING""EDC_CIRCULAR_REFERENCE"

    • qMessageobject
      Show qMessage properties
      • qMessageCodeinteger

        Code number to the corresponding localized message string.

        format = int32

      • qMessageParametersarray of strings

        Parameters to be inserted in the localized message string.
  • qPersistentProgressMessagesarray of objects

    List of persistent progress messages.

    Show qPersistentProgressMessages properties
    • qMessageCodeinteger

      Code number to the corresponding localized message string.

      format = int32

    • qMessageParametersarray of strings

      Parameters to be inserted in the localized message string.
  • qTransientProgressMessageobject
    Show qTransientProgressMessage properties
    • qMessageCodeinteger

      Code number to the corresponding localized message string.

      format = int32

    • qMessageParametersarray of strings

      Parameters to be inserted in the localized message string.

schemas ProgressMessage object

Properties

  • qMessageCodeinteger

    Code number to the corresponding localized message string.

    format = int32

  • qMessageParametersarray of strings

    Parameters to be inserted in the localized message string.

schemas Range object

Properties

  • qMinnumber

    Lowest value in the range

    format = double

  • qMaxnumber

    Highest value in the range

    format = double

  • qMinInclEqboolean

    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.

  • qMaxInclEqboolean

    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

  • qRangeLonumber

    Lowest value in the range.

    default = -1e+300, format = double, default = -1e+300

  • qRangeHinumber

    Highest value in the range.

    default = -1e+300, format = double, default = -1e+300

  • qMeasurestring

    Label of the measure.

schemas Rect object

Properties

  • qLeftinteger

    Position from the left. Corresponds to the first column.

    format = int32

  • qTopinteger

    Position from the top. Corresponds to the first row.

    format = int32

  • qWidthinteger

    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

  • qHeightinteger

    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 SampleResult object

Properties

  • qFieldOrColumnobject
    Show qFieldOrColumn properties
    • qFieldNamestring

      Name of the field or column to be matched.

    • qTableNamestring

      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.
  • qValuesarray of objects

    Matched values part of the sample.

    Show qValues properties
    • qTextstring

      Text related to the field value. This parameter is optional.

    • qIsNumericboolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumbernumber

      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

  • qErrLeninteger

    Length of the word where the error is located.

    default = 0, format = int32, default = 0

  • qTabIxinteger

    Number of the faulty section.

    default = 0, format = int32, default = 0

  • qLineInTabinteger

    Line number in the section where the error is located.

    default = 0, format = int32, default = 0

  • qColInLineinteger

    Position of the erroneous text from the beginning of the line.

    default = 0, format = int32, default = 0

  • qTextPosinteger

    Position of the erroneous text from the beginning of the script.

    default = 0, format = int32, default = 0

  • qSecondaryFailureboolean

    The default value is false.

schemas ScrollPosition object

Properties

  • qUsePositionboolean
  • qPosobject
    Show qPos properties
    • qxinteger

      x-coordinate in pixels. The origin is the top left of the screen.

      format = int32

    • qyinteger

      y-coordinate in pixels. The origin is the top left of the screen.

      format = int32

schemas SearchAssociationResult object

Deprecated

Properties

  • qFieldNamesarray of strings

    List of the fields that contains search associations.

  • qSearchTermsarray of strings

    List of the search terms.

  • qFieldDictionariesarray of objectsDeprecated

    Information about the fields containing search hits.

    Show qFieldDictionaries properties
    • qFieldinteger

      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

    • qResultarray of objectsDeprecated

      List of the matching values. The maximum number of values in this list is set by qMaxNbrFieldMatches .

      Show qResult properties
      • qTextstring

        Text of the associated value.

      • qElemNumberinteger

        Element number of the associated value.

        format = int32

      • qRangesarray 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
        • qCharPosinteger

          Starting position of the match in the search result, starting from 0.

          format = int32

        • qCharCountinteger

          Length of the match in the search result.

          format = int32

        • qTerminteger

          Position of the term in the list of search terms, starting from 0.

          format = int32

  • qSearchTermsMatchedarray of arraysDeprecated

    List of search results. The maximum number of search results in this list is set by qPage/qCount .

    Show qSearchTermsMatched properties
    • qIdinteger

      Index of the search result, starting from 0.

      format = int32

    • qFieldMatchesarray of objectsDeprecated

      Information about the search matches.

      Show qFieldMatches properties
      • qFieldinteger

        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

      • qValuesarray of integers

        Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .

      • qTermsarray of integers

        Positions of the search terms, starting from 0.

      • qNoOfMatchesinteger

        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

  • qTotalSearchResultsinteger

    Total number of search results. This number is not limited by qPage/qCount .

    format = int32

schemas SearchAttribute object

Properties

  • qKeystring

    String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

  • qValuestring

    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

  • qCharPosinteger

    Starting position of the match in the search result, starting from 0.

    format = int32

  • qCharCountinteger

    Length of the match in the search result.

    format = int32

  • qTerminteger

    Position of the term in the list of search terms, starting from 0.

    format = int32

schemas SearchCombinationOptions object

Properties

  • qSearchFieldsarray of strings

    List of the search fields. If empty, the search is performed in all fields of the app.

  • qContextstring

    Can be one of: "Cleared""LockedFieldsOnly""CurrentSelections"

  • qCharEncodingstring

    Can be one of: "Utf8""Utf16"

  • qAttributesarray 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

  • qFieldinteger

    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

  • qResultarray of objectsDeprecated

    List of the matching values. The maximum number of values in this list is set by qMaxNbrFieldMatches .

    Show qResult properties
    • qTextstring

      Text of the associated value.

    • qElemNumberinteger

      Element number of the associated value.

      format = int32

    • qRangesarray 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
      • qCharPosinteger

        Starting position of the match in the search result, starting from 0.

        format = int32

      • qCharCountinteger

        Length of the match in the search result.

        format = int32

      • qTerminteger

        Position of the term in the list of search terms, starting from 0.

        format = int32

schemas SearchFieldMatch object

Deprecated

Properties

  • qFieldinteger

    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

  • qValuesarray of integers

    Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .

  • qTermsarray of integers

    Positions of the search terms, starting from 0.

  • qNoOfMatchesinteger

    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

  • qTextstring
  • qElemNointeger

    format = int32

  • qSearchTermsMatchedarray of integers

schemas SearchFieldSelectionMode string

oneOf

  • OneAndOnlyOne

    ONE_AND_ONLY_ONE

schemas SearchFieldValueItem object

Experimental

Properties

  • qFieldNamestring

    Field name of matches.

  • qValuesarray of objects
    Experimental

    List of search matches.

    Show qValues properties
    • qTextstring
    • qElemNointeger

      format = int32

    • qSearchTermsMatchedarray of integers

schemas SearchGroup object

Properties

  • qIdinteger

    Identifier of the search group.

    format = int32

  • qGroupTypestring

    Can be one of: "DatasetType""GenericObjectsType"

  • qSearchTermsMatchedarray 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 .

  • qTotalNumberOfItemsinteger

    Total number of distinct items in the search group.

    format = int32

  • qItemsarray 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
    • qItemTypestring

      Can be one of: "Field""GenericObject"

    • qTotalNumberOfMatchesinteger

      Total number of distinct matches in the search group item.

      format = int32

    • qIdentifierstring

      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.
    • qItemMatchesarray 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
      • qTextstring

        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.

      • qFieldSelectionModestring

        Can be one of: "OneAndOnlyOne"

      • qRangesarray 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
        • qCharPosinteger

          Starting position of the match in the search result, starting from 0.

          format = int32

        • qCharCountinteger

          Length of the match in the search result.

          format = int32

        • qTerminteger

          Position of the term in the list of search terms, starting from 0.

          format = int32

      • qAttributesarray 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
        • qKeystring

          String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

        • qValuestring

          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.
    • qSearchTermsMatchedarray 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 .

    • qMatchTypestring

      Can be one of: "FieldMatchNone""FieldMatchSubString""FieldMatchWord""FieldMatchExact""FieldMatchLast"

schemas SearchGroupItem object

Properties

  • qItemTypestring

    Can be one of: "Field""GenericObject"

  • qTotalNumberOfMatchesinteger

    Total number of distinct matches in the search group item.

    format = int32

  • qIdentifierstring

    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.
  • qItemMatchesarray 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
    • qTextstring

      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.

    • qFieldSelectionModestring

      Can be one of: "OneAndOnlyOne"

    • qRangesarray 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
      • qCharPosinteger

        Starting position of the match in the search result, starting from 0.

        format = int32

      • qCharCountinteger

        Length of the match in the search result.

        format = int32

      • qTerminteger

        Position of the term in the list of search terms, starting from 0.

        format = int32

    • qAttributesarray 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
      • qKeystring

        String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

      • qValuestring

        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.
  • qSearchTermsMatchedarray 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 .

  • qMatchTypestring

    Can be one of: "FieldMatchNone""FieldMatchSubString""FieldMatchWord""FieldMatchExact""FieldMatchLast"

schemas SearchGroupItemMatch object

Properties

  • qTextstring

    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.

  • qFieldSelectionModestring

    Can be one of: "OneAndOnlyOne"

  • qRangesarray 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
    • qCharPosinteger

      Starting position of the match in the search result, starting from 0.

      format = int32

    • qCharCountinteger

      Length of the match in the search result.

      format = int32

    • qTerminteger

      Position of the term in the list of search terms, starting from 0.

      format = int32

  • qAttributesarray 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
    • qKeystring

      String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

    • qValuestring

      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

  • qGroupItemTypestring

    Can be one of: "Field""GenericObject"

  • qOffsetinteger

    Position starting from 0. The default value is 0.

    default = 0, format = int32, default = 0

  • qCountinteger

    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

  • qGroupTypestring

    Can be one of: "DatasetType""GenericObjectsType"

  • qOffsetinteger

    Position starting from 0. The default value is 0.

    default = 0, format = int32, default = 0

  • qCountinteger

    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

  • qIdinteger

    Index of the search result, starting from 0.

    format = int32

  • qFieldMatchesarray of objectsDeprecated

    Information about the search matches.

    Show qFieldMatches properties
    • qFieldinteger

      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

    • qValuesarray of integers

      Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .

    • qTermsarray of integers

      Positions of the search terms, starting from 0.

    • qNoOfMatchesinteger

      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

  • qIdinteger

    Index of the search result, starting from 0.

    format = int32

  • qFieldMatchesarray of objectsDeprecated

    Information about the search matches.

    Show qFieldMatches properties
    • qFieldinteger

      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

    • qValuesarray of integers

      Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .

    • qTermsarray of integers

      Positions of the search terms, starting from 0.

    • qNoOfMatchesinteger

      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

  • qAttributesarray of strings

    This array is either empty or contains qProperty .

  • qCharEncodingstring

    Can be one of: "Utf8""Utf16"

schemas SearchPage object

Properties

  • qOffsetinteger

    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

  • qCountinteger

    Number of search groups to return (in qSearchGroupArray ).

    format = int32

  • qMaxNbrFieldMatchesinteger

    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

  • qGroupOptionsarray 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
    • qGroupTypestring

      Can be one of: "DatasetType""GenericObjectsType"

    • qOffsetinteger

      Position starting from 0. The default value is 0.

      default = 0, format = int32, default = 0

    • qCountinteger

      Maximum number of items per group (in qItems[ ] ). The default value is -1; all values are returned.

      default = -1, format = int32, default = -1

  • qGroupItemOptionsarray 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
    • qGroupItemTypestring

      Can be one of: "Field""GenericObject"

    • qOffsetinteger

      Position starting from 0. The default value is 0.

      default = 0, format = int32, default = 0

    • qCountinteger

      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

  • qSearchTermsarray of strings

    List of the search terms.

  • qTotalNumberOfGroupsinteger

    Total number of groups.

    format = int32

  • qSearchGroupArrayarray 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
    • qIdinteger

      Identifier of the search group.

      format = int32

    • qGroupTypestring

      Can be one of: "DatasetType""GenericObjectsType"

    • qSearchTermsMatchedarray 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 .

    • qTotalNumberOfItemsinteger

      Total number of distinct items in the search group.

      format = int32

    • qItemsarray 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
      • qItemTypestring

        Can be one of: "Field""GenericObject"

      • qTotalNumberOfMatchesinteger

        Total number of distinct matches in the search group item.

        format = int32

      • qIdentifierstring

        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.
      • qItemMatchesarray 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
        • qTextstring

          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.

        • qFieldSelectionModestring

          Can be one of: "OneAndOnlyOne"

        • qRangesarray 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
          • qCharPosinteger

            Starting position of the match in the search result, starting from 0.

            format = int32

          • qCharCountinteger

            Length of the match in the search result.

            format = int32

          • qTerminteger

            Position of the term in the list of search terms, starting from 0.

            format = int32

        • qAttributesarray 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
          • qKeystring

            String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.

          • qValuestring

            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.
      • qSearchTermsMatchedarray 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 .

      • qMatchTypestring

        Can be one of: "FieldMatchNone""FieldMatchSubString""FieldMatchWord""FieldMatchExact""FieldMatchLast"

schemas SearchSuggestItem object

Properties

  • qValuestring

    Value of the suggestion.

  • qTerminteger

    Index of the suggestion value. The indexing starts from 0 and from the left.

    format = int32

schemas SearchSuggestionResult object

Properties

  • qSuggestionsarray of objects

    List of suggestions.

    Show qSuggestions properties
    • qValuestring

      Value of the suggestion.

    • qTerminteger

      Index of the suggestion value. The indexing starts from 0 and from the left.

      format = int32

  • qFieldNamesarray of strings

    List of field names that contain search hits.

schemas SearchTermResult object

Deprecated

Properties

  • qTextstring

    Text of the associated value.

  • qElemNumberinteger

    Element number of the associated value.

    format = int32

  • qRangesarray 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
    • qCharPosinteger

      Starting position of the match in the search result, starting from 0.

      format = int32

    • qCharCountinteger

      Length of the match in the search result.

      format = int32

    • qTerminteger

      Position of the term in the list of search terms, starting from 0.

      format = int32

schemas SearchValueOptions object

Experimental

Properties

  • qSearchFieldsarray of strings

    List of the search fields. If empty, the search is performed in all fields of the app.

schemas SearchValuePage object

Experimental

Properties

  • qOffsetinteger

    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

  • qCountinteger

    Number of search fields to return

    format = int32

  • qMaxNbrFieldMatchesinteger

    Maximum number of matching values to return per search result.

    default = -1, format = int32, default = -1

schemas SearchValueResult object

Experimental

Properties

  • qSearchTermsarray of strings

    List of the search terms.

  • qFieldMatchesarray 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
    • qFieldNamestring

      Field name of matches.

    • qValuesarray of objects
      Experimental

      List of search matches.

      Show qValues properties
      • qTextstring
      • qElemNointeger

        format = int32

      • qSearchTermsMatchedarray of integers

schemas SelectInfo object

Properties

  • qTextSearchstring

    Text search string. Everything that matches the text is selected. This parameter is optional.

  • qRangeLonumber

    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

  • qRangeHinumber

    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

  • qNumberFormatobject

    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
    • qTypestring

      Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

    • qnDecinteger

      Number of decimals. Default is 10.

      default = 10, format = int32, default = 10

    • qUseThouinteger

      Defines whether or not a thousands separator must be used. Default is 0.

      default = 0, format = int32, default = 0

    • qFmtstring

      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.

    • qDecstring

      Defines the decimal separator. Example: .

    • qThoustring

      Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
  • qRangeInfoarray 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
    • qRangeLonumber

      Lowest value in the range.

      default = -1e+300, format = double, default = -1e+300

    • qRangeHinumber

      Highest value in the range.

      default = -1e+300, format = double, default = -1e+300

    • qMeasurestring

      Label of the measure.
  • qSoftLockboolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

    default = false

  • qContinuousRangeInfoarray of objects

    List of information about ranges for selections.

    Show qContinuousRangeInfo properties
    • qMinnumber

      Lowest value in the range

      format = double

    • qMaxnumber

      Highest value in the range

      format = double

    • qMinInclEqboolean

      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.

    • qMaxInclEqboolean

      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.
  • qSelectFieldSearchboolean

    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

  • qBackCountinteger

    Number of steps back.

    format = int32

  • qForwardCountinteger

    Number of steps forward.

    format = int32

  • qSelectionsarray of objects

    Lists the fields that are selected.

    Show qSelections properties
    • qTotalinteger

      Number of values in the field.

      format = int32

    • qIsNumboolean

      This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional.

    • qFieldstring

      Name of the field that is selected.

    • qLockedboolean

      This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional.

    • qOneAndOnlyOneboolean

      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.

    • qTextSearchstring

      Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional.

    • qSelectedCountinteger

      Number of values that are selected.

      format = int32

    • qSelectedstring

      Values that are selected.

    • qRangeInfoarray of objects

      Information about the range of selected values. Is empty if there is no range of selected values.

      Show qRangeInfo properties
      • qRangeLonumber

        Lowest value in the range.

        default = -1e+300, format = double, default = -1e+300

      • qRangeHinumber

        Highest value in the range.

        default = -1e+300, format = double, default = -1e+300

      • qMeasurestring

        Label of the measure.
    • qSortIndexinteger

      Sort index of the field. Indexing starts from 0.

      format = int32

    • qStateCountsobject
      Show qStateCounts properties
      • qLockedinteger

        Number of values in locked state.

        format = int32

      • qSelectedinteger

        Number of values in selected state.

        format = int32

      • qOptioninteger

        Number of values in optional state.

        format = int32

      • qDeselectedinteger

        Number of values in deselected state.

        format = int32

      • qAlternativeinteger

        Number of values in alternative state.

        format = int32

      • qExcludedinteger

        Number of values in excluded state.

        format = int32

      • qSelectedExcludedinteger

        Number of values in selected excluded state.

        format = int32

      • qLockedExcludedinteger

        Number of values in locked excluded state.

        format = int32

    • qSelectedFieldSelectionInfoarray of objects

      Information about the fields that are selected.

      Show qSelectedFieldSelectionInfo properties
      • qNamestring

        Name of the field.

      • qFieldSelectionModestring

        Can be one of: "NORMAL""AND""NOT"

    • qNotSelectedFieldSelectionInfoarray of objects

      Information about the fields that are not selected.

      Show qNotSelectedFieldSelectionInfo properties
      • qNamestring

        Name of the field.

      • qFieldSelectionModestring

        Can be one of: "NORMAL""AND""NOT"

    • qSelectionThresholdinteger

      Maximum values to show in the current selections. The default value is 6.

      format = int32

    • qReadableNamestring

      Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly.

    • qIsHiddenboolean

      Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden.

    • qDimensionReferencesarray of objects
      Experimental

      List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem.

      Show qDimensionReferences properties
      • qIdstring

        Identifier of the associated dimension.

      • qLabelstring

        Text label.
  • qStateNamestring

    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

  • qStateNamestring

    Name of the alternate state. Default is current selections $ .

schemas Size object

Properties

  • qcxinteger

    Number of pixels on the x axis.

    format = int32

  • qcyinteger

    Number of pixels on the y axis.

    format = int32

schemas SortCriteria object

Properties

  • qSortByStateinteger

    Sorts the field values according to their logical state (selected, optional, alternative or excluded).

    format = int8

  • qSortByFrequencyinteger

    Sorts the field values by frequency (number of occurrences in the field).

    format = int8

  • qSortByNumericinteger

    Sorts the field values by numeric value.

    format = int8

  • qSortByAsciiinteger

    Sorts the field by alphabetical order.

    format = int8

  • qSortByLoadOrderinteger

    Sorts the field values by the initial load order.

    format = int8

  • qSortByExpressioninteger

    Sorts the field by expression.

    format = int8

  • qExpressionobject
    Show qExpression properties
    • qvstring

      Expression evaluated to dual.
  • qSortByGreynessinteger

    format = int8

schemas SourceKeyRecord object

Properties

  • qKeyFieldsarray of strings

    Name of the key field.

  • qTablesarray 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

  • qStateNamestring

    Name of the state.

  • qFieldValuesarray of objects

    The field values associated with the state.

    Show qFieldValues properties
    • qTextstring

      Text related to the field value. This parameter is optional.

    • qIsNumericboolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumbernumber

      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

  • qItemsarray of objects

    Information about the list of content files.

    Show qItems properties
    • qUrlDefstring

      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.
    • qUrlstring

      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

  • qUrlDefstring

    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.
  • qUrlstring

    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

  • qUrlstring

    Relative path of the thumbnail.

schemas StaticContentUrlDef object

In addition, this structure can contain dynamic properties.

Properties

  • qUrlstring

    Relative path of the thumbnail.

schemas StringExpr object

Properties

  • qvstring

    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

  • qExprstring

schemas SymbolFrequency object

Properties

  • qSymbolobject
    Show qSymbol properties
    • qTextstring

      String value of the symbol. This parameter is optional and present only if Symbol is a string.

    • qNumbernumber

      Numeric value of the symbol. NaN otherwise.

      format = double

  • qFrequencyinteger

    Frequency of the above symbol in the field

    format = int64

schemas SymbolValue object

Properties

  • qTextstring

    String value of the symbol. This parameter is optional and present only if Symbol is a string.

  • qNumbernumber

    Numeric value of the symbol. NaN otherwise.

    format = double

schemas TableProfilingData object

Properties

  • qNoOfRowsinteger

    Number of rows in the table.

    format = int64

  • qFieldProfilingarray of objects

    Field values profiling info

    Show qFieldProfiling properties
    • qNamestring

      Name of the field.

    • qFieldTagsarray of strings

      List of tags related to the field.

    • qNumberFormatobject

      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
      • qTypestring

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qDistinctValuesinteger

      Number of distinct values

      format = int64

    • qDistinctNumericValuesinteger

      Number of distinct numeric values

      format = int64

    • qDistinctTextValuesinteger

      Number of distinct text values

      format = int64

    • qNumericValuesinteger

      Number of numeric values

      format = int64

    • qNullValuesinteger

      Number of null values

      format = int64

    • qTextValuesinteger

      Number of textual values

      format = int64

    • qNegValuesinteger

      Number of negative values

      format = int64

    • qPosValuesinteger

      Number of positive values

      format = int64

    • qZeroValuesinteger

      Number of zero values for numerical values

      format = int64

    • qSumnumber

      Sum of all numerical values. NaN otherwise.

      format = double

    • qSum2number

      Squared sum of all numerical values. NaN otherwise.

      format = double

    • qAveragenumber

      Average of all numerical values. NaN otherwise.

      format = double

    • qMediannumber

      Median of all numerical values. NaN otherwise.

      format = double

    • qStdnumber

      Standard deviation of numerical values. NaN otherwise.

      format = double

    • qMinnumber

      Minimum value of numerical values. NaN otherwise.

      format = double

    • qMaxnumber

      Maximum value of numerical values. NaN otherwise.

      format = double

    • qSkewnessnumber

      Skewness of the numerical values. NaN otherwise.

      format = double

    • qKurtosisnumber

      Kurtosis of the numerical values. NaN otherwise.

      format = double

    • qFractilesarray of numbers

      The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

    • qEmptyStringsinteger

      Number of empty strings

      format = int64

    • qMaxStringLeninteger

      Maximum string length of textual values. 0 otherwise.

      format = int64

    • qMinStringLeninteger

      Minimum string length of textual values. 0 otherwise.

      format = int64

    • qSumStringLeninteger

      Sum of all characters in strings in the field

      format = int64

    • qAvgStringLennumber

      Average string length of textual values. 0 otherwise.

      format = double

    • qFirstSortedstring

      For textual values the first sorted string.

    • qLastSortedstring

      For textual values the last sorted string.

    • qMostFrequentarray of objects

      Three most frequent values and their frequencies

      Show qMostFrequent properties
      • qSymbolobject
        Show qSymbol properties
        • qTextstring

          String value of the symbol. This parameter is optional and present only if Symbol is a string.

        • qNumbernumber

          Numeric value of the symbol. NaN otherwise.

          format = double

      • qFrequencyinteger

        Frequency of the above symbol in the field

        format = int64

    • qFrequencyDistributionobject
      Show qFrequencyDistribution properties
      • qNumberOfBinsinteger

        Number of bins.

        format = int32

      • qBinsEdgesarray of numbers

        Bins edges.

      • qFrequenciesarray of integers

        Bins frequencies.

schemas TableRecord object

Properties

  • qNamestring

    Name of the table.

  • qLooseboolean

    This property is set to true if the table is loose.

  • qNoOfRowsinteger

    Number of rows in the table.

    format = int64

  • qFieldsarray of objects

    Information about the fields in the table.

    Show qFields properties
    • qNamestring

      Name of the field.

    • qOriginalFieldsarray 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.

    • qPresentboolean
    • qHasNullboolean

      This property is set to true if the field contains some Null values.

    • qHasWildboolean
    • qHasDuplicatesboolean

      This property is set to true if the field contains some duplicate values.

    • qIsSyntheticboolean

      This property is set to true if the field contains a synthetic key.

    • qInformationDensitynumber

      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

    • qnNonNullsinteger

      Number of values that are non Null.

      format = int64

    • qnRowsinteger

      Number of rows in the field.

      format = int64

    • qSubsetRationumber

      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

    • qnTotalDistinctValuesinteger

      Number of distinct values in the field.

      format = int32

    • qnPresentDistinctValuesinteger

      format = int32

    • qKeyTypestring

      Can be one of: "NOT_KEY""ANY_KEY""PRIMARY_KEY""PERFECT_KEY"

    • qCommentstring

      Comment related to the field.

    • qTagsarray of strings

      List of tags related to the field.

    • qDerivedFieldsarray of objects

      List of the derived fields.

      Show qDerivedFields properties
      • qDefinitionNamestring

        Name of the derived definition.

      • qTagsarray of strings

        List of tags.

      • qActiveboolean

        Is set to true is the derived field is in use.
    • qIsFieldOnTheFlyboolean

      default = false

    • qReadableNamestring
  • qPosobject
    Show qPos properties
    • qxinteger

      x-coordinate in pixels. The origin is the top left of the screen.

      format = int32

    • qyinteger

      y-coordinate in pixels. The origin is the top left of the screen.

      format = int32

  • qCommentstring

    Comment related to the table.

  • qIsDirectDiscoveryboolean

    If set to true, Direct Discovery is used. Direct Discovery fields are not loaded into memory and remain in the external database.

  • qIsSyntheticboolean

    This property is set to true if the table contains a synthetic key.

  • qTableTagsarray of strings

    List of tags related to the table.

  • qProfilingDataobject
    Show qProfilingData properties
    • qNoOfRowsinteger

      Number of rows in the table.

      format = int64

    • qFieldProfilingarray of objects

      Field values profiling info

      Show qFieldProfiling properties
      • qNamestring

        Name of the field.

      • qFieldTagsarray of strings

        List of tags related to the field.

      • qNumberFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qDistinctValuesinteger

        Number of distinct values

        format = int64

      • qDistinctNumericValuesinteger

        Number of distinct numeric values

        format = int64

      • qDistinctTextValuesinteger

        Number of distinct text values

        format = int64

      • qNumericValuesinteger

        Number of numeric values

        format = int64

      • qNullValuesinteger

        Number of null values

        format = int64

      • qTextValuesinteger

        Number of textual values

        format = int64

      • qNegValuesinteger

        Number of negative values

        format = int64

      • qPosValuesinteger

        Number of positive values

        format = int64

      • qZeroValuesinteger

        Number of zero values for numerical values

        format = int64

      • qSumnumber

        Sum of all numerical values. NaN otherwise.

        format = double

      • qSum2number

        Squared sum of all numerical values. NaN otherwise.

        format = double

      • qAveragenumber

        Average of all numerical values. NaN otherwise.

        format = double

      • qMediannumber

        Median of all numerical values. NaN otherwise.

        format = double

      • qStdnumber

        Standard deviation of numerical values. NaN otherwise.

        format = double

      • qMinnumber

        Minimum value of numerical values. NaN otherwise.

        format = double

      • qMaxnumber

        Maximum value of numerical values. NaN otherwise.

        format = double

      • qSkewnessnumber

        Skewness of the numerical values. NaN otherwise.

        format = double

      • qKurtosisnumber

        Kurtosis of the numerical values. NaN otherwise.

        format = double

      • qFractilesarray of numbers

        The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

      • qEmptyStringsinteger

        Number of empty strings

        format = int64

      • qMaxStringLeninteger

        Maximum string length of textual values. 0 otherwise.

        format = int64

      • qMinStringLeninteger

        Minimum string length of textual values. 0 otherwise.

        format = int64

      • qSumStringLeninteger

        Sum of all characters in strings in the field

        format = int64

      • qAvgStringLennumber

        Average string length of textual values. 0 otherwise.

        format = double

      • qFirstSortedstring

        For textual values the first sorted string.

      • qLastSortedstring

        For textual values the last sorted string.

      • qMostFrequentarray of objects

        Three most frequent values and their frequencies

        Show qMostFrequent properties
        • qSymbolobject
          Show qSymbol properties
          • qTextstring

            String value of the symbol. This parameter is optional and present only if Symbol is a string.

          • qNumbernumber

            Numeric value of the symbol. NaN otherwise.

            format = double

        • qFrequencyinteger

          Frequency of the above symbol in the field

          format = int64

      • qFrequencyDistributionobject
        Show qFrequencyDistribution properties
        • qNumberOfBinsinteger

          Number of bins.

          format = int32

        • qBinsEdgesarray of numbers

          Bins edges.

        • qFrequenciesarray of integers

          Bins frequencies.

schemas TableRow object

Properties

  • qValuearray of objects

    Array of field values.

    Show qValue properties
    • qTextstring

      Text related to the field value. This parameter is optional.

    • qIsNumericboolean

      Is set to true if the value is a numeric. This parameter is optional. Default is false.

    • qNumbernumber

      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

  • qPosobject
    Show qPos properties
    • qxinteger

      x-coordinate in pixels. The origin is the top left of the screen.

      format = int32

    • qyinteger

      y-coordinate in pixels. The origin is the top left of the screen.

      format = int32

  • qTablestring

    Name of the table.

  • qFieldsarray of strings

    List of fields in the table.

schemas TableViewConnectionPointSaveInfo object

Properties

  • qPosobject
    Show qPos properties
    • qxinteger

      x-coordinate in pixels. The origin is the top left of the screen.

      format = int32

    • qyinteger

      y-coordinate in pixels. The origin is the top left of the screen.

      format = int32

  • qFieldsarray of strings

    List of the fields in the table.

schemas TableViewCtlSaveInfo object

Properties

  • qInternalViewobject
    Show qInternalView properties
    • qTablesarray of objects

      List of the tables in the database model viewer.

      Show qTables properties
      • qPosobject
        Show qPos properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          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

        • qHeightinteger

          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

      • qCaptionstring

        Table name.
    • qBroomPointsarray of objects

      List of the broom points in the database model viewer. Not used in Qlik Sense.

      Show qBroomPoints properties
      • qPosobject
        Show qPos properties
        • qxinteger

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qyinteger

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

      • qTablestring

        Name of the table.

      • qFieldsarray of strings

        List of fields in the table.
    • qConnectionPointsarray of objects

      List of connection points in the database model viewer. Not used in Qlik Sense.

      Show qConnectionPoints properties
      • qPosobject
        Show qPos properties
        • qxinteger

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qyinteger

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

      • qFieldsarray of strings

        List of the fields in the table.
    • qZoomFactornumber

      Zoom factor in the database model viewer. The default value is 1.0.

      default = 1, format = double, default = 1

  • qSourceViewobject
    Show qSourceView properties
    • qTablesarray of objects

      List of the tables in the database model viewer.

      Show qTables properties
      • qPosobject
        Show qPos properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          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

        • qHeightinteger

          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

      • qCaptionstring

        Table name.
    • qBroomPointsarray of objects

      List of the broom points in the database model viewer. Not used in Qlik Sense.

      Show qBroomPoints properties
      • qPosobject
        Show qPos properties
        • qxinteger

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qyinteger

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

      • qTablestring

        Name of the table.

      • qFieldsarray of strings

        List of fields in the table.
    • qConnectionPointsarray of objects

      List of connection points in the database model viewer. Not used in Qlik Sense.

      Show qConnectionPoints properties
      • qPosobject
        Show qPos properties
        • qxinteger

          x-coordinate in pixels. The origin is the top left of the screen.

          format = int32

        • qyinteger

          y-coordinate in pixels. The origin is the top left of the screen.

          format = int32

      • qFieldsarray of strings

        List of the fields in the table.
    • qZoomFactornumber

      Zoom factor in the database model viewer. The default value is 1.0.

      default = 1, format = double, default = 1

schemas TableViewDlgSaveInfo object

Properties

  • qPosobject
    Show qPos properties
    • qLeftinteger

      Position from the left. Corresponds to the first column.

      format = int32

    • qTopinteger

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidthinteger

      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

    • qHeightinteger

      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

  • qCtlInfoobject
    Show qCtlInfo properties
    • qInternalViewobject
      Show qInternalView properties
      • qTablesarray of objects

        List of the tables in the database model viewer.

        Show qTables properties
        • qPosobject
          Show qPos properties
          • qLeftinteger

            Position from the left. Corresponds to the first column.

            format = int32

          • qTopinteger

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidthinteger

            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

          • qHeightinteger

            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

        • qCaptionstring

          Table name.
      • qBroomPointsarray of objects

        List of the broom points in the database model viewer. Not used in Qlik Sense.

        Show qBroomPoints properties
        • qPosobject
          Show qPos properties
          • qxinteger

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qyinteger

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

        • qTablestring

          Name of the table.

        • qFieldsarray of strings

          List of fields in the table.
      • qConnectionPointsarray of objects

        List of connection points in the database model viewer. Not used in Qlik Sense.

        Show qConnectionPoints properties
        • qPosobject
          Show qPos properties
          • qxinteger

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qyinteger

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

        • qFieldsarray of strings

          List of the fields in the table.
      • qZoomFactornumber

        Zoom factor in the database model viewer. The default value is 1.0.

        default = 1, format = double, default = 1

    • qSourceViewobject
      Show qSourceView properties
      • qTablesarray of objects

        List of the tables in the database model viewer.

        Show qTables properties
        • qPosobject
          Show qPos properties
          • qLeftinteger

            Position from the left. Corresponds to the first column.

            format = int32

          • qTopinteger

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidthinteger

            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

          • qHeightinteger

            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

        • qCaptionstring

          Table name.
      • qBroomPointsarray of objects

        List of the broom points in the database model viewer. Not used in Qlik Sense.

        Show qBroomPoints properties
        • qPosobject
          Show qPos properties
          • qxinteger

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qyinteger

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

        • qTablestring

          Name of the table.

        • qFieldsarray of strings

          List of fields in the table.
      • qConnectionPointsarray of objects

        List of connection points in the database model viewer. Not used in Qlik Sense.

        Show qConnectionPoints properties
        • qPosobject
          Show qPos properties
          • qxinteger

            x-coordinate in pixels. The origin is the top left of the screen.

            format = int32

          • qyinteger

            y-coordinate in pixels. The origin is the top left of the screen.

            format = int32

        • qFieldsarray of strings

          List of the fields in the table.
      • qZoomFactornumber

        Zoom factor in the database model viewer. The default value is 1.0.

        default = 1, format = double, default = 1

  • qModeinteger

    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

  • qTablesarray of objects

    List of the tables in the database model viewer.

    Show qTables properties
    • qPosobject
      Show qPos properties
      • qLeftinteger

        Position from the left. Corresponds to the first column.

        format = int32

      • qTopinteger

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidthinteger

        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

      • qHeightinteger

        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

    • qCaptionstring

      Table name.
  • qBroomPointsarray of objects

    List of the broom points in the database model viewer. Not used in Qlik Sense.

    Show qBroomPoints properties
    • qPosobject
      Show qPos properties
      • qxinteger

        x-coordinate in pixels. The origin is the top left of the screen.

        format = int32

      • qyinteger

        y-coordinate in pixels. The origin is the top left of the screen.

        format = int32

    • qTablestring

      Name of the table.

    • qFieldsarray of strings

      List of fields in the table.
  • qConnectionPointsarray of objects

    List of connection points in the database model viewer. Not used in Qlik Sense.

    Show qConnectionPoints properties
    • qPosobject
      Show qPos properties
      • qxinteger

        x-coordinate in pixels. The origin is the top left of the screen.

        format = int32

      • qyinteger

        y-coordinate in pixels. The origin is the top left of the screen.

        format = int32

    • qFieldsarray of strings

      List of the fields in the table.
  • qZoomFactornumber

    Zoom factor in the database model viewer. The default value is 1.0.

    default = 1, format = double, default = 1

schemas TableViewTableWinSaveInfo object

Properties

  • qPosobject
    Show qPos properties
    • qLeftinteger

      Position from the left. Corresponds to the first column.

      format = int32

    • qTopinteger

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidthinteger

      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

    • qHeightinteger

      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

  • qCaptionstring

    Table name.

schemas TextMacro object

Properties

  • qTagstring

    Name of the variable.

  • qRefSeqNointeger

    Order in which the variable was referenced during the script execution. The same number sequence is used for both qRefSeqNo and qSetSeqNo .

    format = int32

  • qSetSeqNointeger

    Order in which the variable was updated during the script execution. The same number sequence is used for both qRefSeqNo and qSetSeqNo .

    format = int32

  • qDisplayStringstring

    Variable value.

  • qIsSystemboolean

    Is set to true if the variable is a system variable.

    default = false

  • qIsReservedboolean

    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

  • qNamestring

    The name (title) of the application

  • qSpaceIdstring

    ID of the space where the app is to be created. Empty value implies Personal space

  • qScriptParameterPrefixstring

    Prefix to be used on inserted ScriptParameters, only applicable for template apps

schemas TransformAppResult object

Properties

  • qAppIdstring

    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

  • qStateNamestring

    Name of the alternate state. Default is current selections $ .

  • qNodesOnDimarray of integers

    The total number of nodes on each dimension.

  • qErrorobject
    Show qError properties
    • qErrorCodeinteger

      Error code. This parameter is always displayed in case of error.

      format = int32

    • qContextstring

      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.

    • qExtendedMessagestring

      Internal information from the server. This parameter is optional.
  • qDimensionInfoarray of objects

    Information on the dimension.

    Show qDimensionInfo properties
    • qFallbackTitlestring

      Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used.

    • qApprMaxGlyphCountinteger

      Length of the longest value in the field.

      format = int32

    • qCardinalintegerDeprecated

      Number of distinct field values.

      format = int32

    • qLockedboolean

      Is set to true if the field is locked.

    • qSortIndicatorstring

      Can be one of: "N""A""D"

    • qGroupFallbackTitlesarray 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).

    • qGroupPosinteger

      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

    • qStateCountsobject
      Show qStateCounts properties
      • qLockedinteger

        Number of values in locked state.

        format = int32

      • qSelectedinteger

        Number of values in selected state.

        format = int32

      • qOptioninteger

        Number of values in optional state.

        format = int32

      • qDeselectedinteger

        Number of values in deselected state.

        format = int32

      • qAlternativeinteger

        Number of values in alternative state.

        format = int32

      • qExcludedinteger

        Number of values in excluded state.

        format = int32

      • qSelectedExcludedinteger

        Number of values in selected excluded state.

        format = int32

      • qLockedExcludedinteger

        Number of values in locked excluded state.

        format = int32

    • qTagsarray of strings

      Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qDimensionTypestring

      Can be one of: "D""N""T"

    • qReverseSortboolean

      If set to true, it inverts the sort criteria in the field.

    • qGroupingstring

      Can be one of: "N""H""C"

    • qIsSemanticboolean

      If set to true, it means that the field is a semantic.

    • qNumFormatobject

      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
      • qTypestring

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qIsAutoFormatboolean

      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.

    • qGroupFieldDefsarray of strings

      Array of field names.

    • qMinnumber

      Minimum value.

      format = double

    • qMaxnumber

      Maximum value.

      format = double

    • qContinuousAxesboolean

      Is continuous axis used.

    • qIsCyclicboolean

      Is a cyclic dimension used.

    • qDerivedFieldboolean

      Is derived field is used as a dimension.

    • qMeasureInfoarray of objects

      A List of measures to be calculated on this TreeDimension.

      Show qMeasureInfo properties
      • qFallbackTitlestring

        Corresponds to the label of the measure. If the label is not defined then the measure name is used.

      • qApprMaxGlyphCountinteger

        Length of the longest value in the field.

        format = int32

      • qCardinalinteger

        Number of distinct field values.

        format = int32

      • qSortIndicatorstring

        Can be one of: "N""A""D"

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qMinnumber

        Lowest value in the range.

        format = double

      • qMaxnumber

        Highest value in the range.

        format = double

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qReverseSortboolean

        If set to true, it inverts the sort criteria in the field.

      • qIsAutoFormatboolean

        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.

      • qAttrExprInfoarray of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMinnumber

          Minimum value.

          format = double

        • qMaxnumber

          Maximum value.

          format = double

        • qFallbackTitlestring
        • qMinTextstring

          String version of the minimum Value.

        • qMaxTextstring

          String version of the maximum Value.

        • qNumFormatobject

          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
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qIsAutoFormatboolean

          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.
      • qAttrDimInfoarray of objects

        List of attribute dimensions.

        Show qAttrDimInfo properties
        • qCardinalinteger

          Cardinality of the attribute expression.

          format = int32

        • qSizeobject
          Show qSize properties
          • qcxinteger

            Number of pixels on the x axis.

            format = int32

          • qcyinteger

            Number of pixels on the y axis.

            format = int32

        • qFallbackTitlestring

          The title for the attribute dimension.

        • qLockedboolean

          The Locked value of the dimension.

        • qErrorobject
          Show qError properties
          • qErrorCodeinteger

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContextstring

            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.

          • qExtendedMessagestring

            Internal information from the server. This parameter is optional.
        • qIsCalculatedboolean

          True if this is a calculated dimension.

          default = false

      • qCalcCondMsgstring

        The message displayed if calculation condition is not fulfilled.

      • qLibraryIdstring

        Refers to a dimension stored in the library.

      • qTrendLinesarray of objects
        Experimental

        Calculated trendlines

        Show qTrendLines properties
        • qTypestring

          Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

        • qErrorobject
          Show qError properties
          • qErrorCodeinteger

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContextstring

            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.

          • qExtendedMessagestring

            Internal information from the server. This parameter is optional.
        • qCoeffarray of numbers

          Coefficent c0..cN depending on the trendline type.

        • qR2number

          R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

          format = double

        • qExpressionstring

          Trendline expression

        • qElemNointeger

          Inner Dim elem no

          format = int32

      • qMiniChartobject
        Show qMiniChart properties
        • qYMinnumber

          format = double

        • qYMaxnumber

          format = double

        • qXMinnumber

          format = double

        • qXMaxnumber

          format = double

        • qAttrExprInfoarray of objects

          List of attribute expressions.

          Show qAttrExprInfo properties
          • qMinnumber

            Minimum value.

            format = double

          • qMaxnumber

            Maximum value.

            format = double

          • qFallbackTitlestring
          • qMinTextstring

            String version of the minimum Value.

          • qMaxTextstring

            String version of the maximum Value.

          • qNumFormatobject

            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
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              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.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qIsAutoFormatboolean

            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.
        • qErrorobject
          Show qError properties
          • qErrorCodeinteger

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContextstring

            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.

          • qExtendedMessagestring

            Internal information from the server. This parameter is optional.
    • qAttrExprInfoarray of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMinnumber

        Minimum value.

        format = double

      • qMaxnumber

        Maximum value.

        format = double

      • qFallbackTitlestring
      • qMinTextstring

        String version of the minimum Value.

      • qMaxTextstring

        String version of the maximum Value.

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qIsAutoFormatboolean

        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.
    • qAttrDimInfoarray of objects

      List of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinalinteger

        Cardinality of the attribute expression.

        format = int32

      • qSizeobject
        Show qSize properties
        • qcxinteger

          Number of pixels on the x axis.

          format = int32

        • qcyinteger

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitlestring

        The title for the attribute dimension.

      • qLockedboolean

        The Locked value of the dimension.

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qIsCalculatedboolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsgstring

      The message displayed if calculation condition is not fulfilled.

    • qIsCalculatedboolean

      True if this is a calculated dimension.

      default = false

    • qIsOneAndOnlyOneboolean

      If set to true, it means that the field always has one and only one selected value.

    • qCardinalitiesobject
      Show qCardinalities properties
      • qCardinalinteger

        Number of distinct field values.

        format = int32

      • qHypercubeCardinalinteger

        Number of distinct hypercube values.

        format = int32

      • qAllValuesCardinalinteger

        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

    • qLibraryIdstring

      Refers to a dimension stored in the library.
  • qEffectiveInterColumnSortOrderarray 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.

  • qHasOtherValuesboolean

    True if other row exists.

  • qTitlestring

    Title of the TreeData object, for example the title of a chart.

  • qLastExpandedPosobject
    Show qLastExpandedPos properties
    • qxinteger

      Position of the cell on the x-axis.

      format = int32

    • qyinteger

      Position of the cell on the y-axis.

      format = int32

  • qCalcCondMsgstring

    The message displayed if calculation condition is not fulfilled.

  • qTreeDataPagesarray of objects

    Set of data. Is empty if nothing has been defined in qInitialDataFetch in TreeDataDef.

    Show qTreeDataPages properties
    • qTextstring

      The text version of the value, if available.

    • qValuenumber

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qElemNointeger

      Element number.

      format = int32

    • qGroupPosinteger

      The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

      format = int32

    • qGroupSizeinteger

      Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

      format = int32

    • qRowinteger

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qTypestring

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qValuesarray of objects

      The measures for this node.

      Show qValues properties
      • qTextstring

        The text version of the value, if available.

      • qValuenumber

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qAttrExpsobject
        Show qAttrExps properties
        • qValuesarray of objects

          List of attribute expressions values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value.

          • qNumnumber

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDimsobject
        Show qAttrDims properties
        • qValuesarray of objects

          List of values.

          Show qValues properties
          • qTextstring

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNointeger

            Element number.

            format = int32

    • qNodesarray of undefineds

      The children of this node in the fetched tree structure.

    • qAttrExpsobject
      Show qAttrExps properties
      • qValuesarray of objects

        List of attribute expressions values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value.

        • qNumnumber

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDimsobject
      Show qAttrDims properties
      • qValuesarray of objects

        List of values.

        Show qValues properties
        • qTextstring

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNointeger

          Element number.

          format = int32

    • qMaxPosarray of numbers

      Total of the positive values in the current group of cells.

    • qMinNegarray of numbers

      Total of the negative values in the current group of cells.

    • qCanExpandboolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapseboolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qStatestring

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qTreePatharray 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.
  • qMeasureInfoarray of objects

    Information on the measures calculated on the whole tree.

    Show qMeasureInfo properties
    • qFallbackTitlestring

      Corresponds to the label of the measure. If the label is not defined then the measure name is used.

    • qApprMaxGlyphCountinteger

      Length of the longest value in the field.

      format = int32

    • qCardinalinteger

      Number of distinct field values.

      format = int32

    • qSortIndicatorstring

      Can be one of: "N""A""D"

    • qNumFormatobject

      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
      • qTypestring

        Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

      • qnDecinteger

        Number of decimals. Default is 10.

        default = 10, format = int32, default = 10

      • qUseThouinteger

        Defines whether or not a thousands separator must be used. Default is 0.

        default = 0, format = int32, default = 0

      • qFmtstring

        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.

      • qDecstring

        Defines the decimal separator. Example: .

      • qThoustring

        Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
    • qMinnumber

      Lowest value in the range.

      format = double

    • qMaxnumber

      Highest value in the range.

      format = double

    • qErrorobject
      Show qError properties
      • qErrorCodeinteger

        Error code. This parameter is always displayed in case of error.

        format = int32

      • qContextstring

        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.

      • qExtendedMessagestring

        Internal information from the server. This parameter is optional.
    • qReverseSortboolean

      If set to true, it inverts the sort criteria in the field.

    • qIsAutoFormatboolean

      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.

    • qAttrExprInfoarray of objects

      List of attribute expressions.

      Show qAttrExprInfo properties
      • qMinnumber

        Minimum value.

        format = double

      • qMaxnumber

        Maximum value.

        format = double

      • qFallbackTitlestring
      • qMinTextstring

        String version of the minimum Value.

      • qMaxTextstring

        String version of the maximum Value.

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qIsAutoFormatboolean

        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.
    • qAttrDimInfoarray of objects

      List of attribute dimensions.

      Show qAttrDimInfo properties
      • qCardinalinteger

        Cardinality of the attribute expression.

        format = int32

      • qSizeobject
        Show qSize properties
        • qcxinteger

          Number of pixels on the x axis.

          format = int32

        • qcyinteger

          Number of pixels on the y axis.

          format = int32

      • qFallbackTitlestring

        The title for the attribute dimension.

      • qLockedboolean

        The Locked value of the dimension.

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qIsCalculatedboolean

        True if this is a calculated dimension.

        default = false

    • qCalcCondMsgstring

      The message displayed if calculation condition is not fulfilled.

    • qLibraryIdstring

      Refers to a dimension stored in the library.

    • qTrendLinesarray of objects
      Experimental

      Calculated trendlines

      Show qTrendLines properties
      • qTypestring

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          Internal information from the server. This parameter is optional.
      • qCoeffarray of numbers

        Coefficent c0..cN depending on the trendline type.

      • qR2number

        R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

        format = double

      • qExpressionstring

        Trendline expression

      • qElemNointeger

        Inner Dim elem no

        format = int32

    • qMiniChartobject
      Show qMiniChart properties
      • qYMinnumber

        format = double

      • qYMaxnumber

        format = double

      • qXMinnumber

        format = double

      • qXMaxnumber

        format = double

      • qAttrExprInfoarray of objects

        List of attribute expressions.

        Show qAttrExprInfo properties
        • qMinnumber

          Minimum value.

          format = double

        • qMaxnumber

          Maximum value.

          format = double

        • qFallbackTitlestring
        • qMinTextstring

          String version of the minimum Value.

        • qMaxTextstring

          String version of the maximum Value.

        • qNumFormatobject

          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
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qIsAutoFormatboolean

          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.
      • qErrorobject
        Show qError properties
        • qErrorCodeinteger

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContextstring

          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.

        • qExtendedMessagestring

          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

  • qStateNamestring

    Name of the alternate state. Default is current selections $ .

  • qDimensionsarray of objects

    Array of dimensions.

    Show qDimensions properties
    • qLibraryIdstring

      Refers to a dimension stored in the library.

    • qDefobject
      Show qDef properties
      • qGroupingstring

        Can be one of: "N""H""C"

      • qFieldDefsarray of strings

        Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

      • qFieldLabelsarray of strings

        Array of field labels. This parameter is optional.

      • qSortCriteriasarray of objects

        Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

        Show qSortCriterias properties
        • qSortByStateinteger

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequencyinteger

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qNumberPresentationsarray of objects

        Defines the format of the value. This parameter is optional.

        Show qNumberPresentations properties
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qReverseSortboolean

        If set to true, it inverts the sort criteria in the field.

      • qActiveFieldinteger

        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

      • qLabelExpressionstring

        Label expression. This parameter is optional.

      • qAliasstring

        Alias of the dimension.
    • qValueExprsarray of objects

      List of measures.

      Show qValueExprs properties
      • qLibraryIdstring

        Refers to a measure stored in the library.

      • qDefobject
        Show qDef properties
        • qLabelstring

          Name of the measure. An empty string is returned as a default value. This parameter is optional.

        • qDescriptionstring

          Description of the measure. An empty string is returned as a default value. This parameter is optional.

        • qTagsarray of strings

          Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

        • qGroupingstring

          Can be one of: "N""H""C"

        • qDefstring

          Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

        • qNumFormatobject

          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
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qRelativeboolean

          If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

        • qBrutalSumboolean

          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 .

        • qAggrFuncstring

          Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

        • qAccumulateinteger
          • 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

        • qReverseSortboolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveExpressioninteger

          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

        • qExpressionsarray 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.

        • qLabelExpressionstring

          Label expression. This parameter is optional.
      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequencyinteger

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qAttributeExpressionsarray of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpressionstring

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryIdstring

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttributeboolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormatobject

          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
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabelstring

          Label of the attribute expression.

        • qLabelExpressionstring

          Optional expression used for dynamic label.
      • qAttributeDimensionsarray of objects

        List of attribute dimensions.

        Show qAttributeDimensions properties
        • qDefstring

          Expression or field name.

        • qLibraryIdstring

          LibraryId for dimension.

        • qSortByobject
          Show qSortBy properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeboolean

          If set to true, this attribute will not affect the number of rows in the cube.
      • qCalcCondobject
        Show qCalcCond properties
        • qvstring

          Expression evaluated to dual.
      • qCalcConditionobject
        Show qCalcCondition properties
        • qCondobject
          Show qCond properties
          • qvstring

            Expression evaluated to dual.
        • qMsgobject
          Show qMsg properties
          • qvstring

            Expression evaluated to string.
      • qTrendLinesarray of objects
        Experimental

        Specifies trendlines for this measure.

        Show qTrendLines properties
        • qTypestring

          Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

        • qXColIxinteger

          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

        • qCalcR2boolean

          Set to true to calulatate the R2 score

          default = false

        • qContinuousXAxisstring

          Can be one of: "Never""Possible""Time"

        • qMultiDimModestring

          Can be one of: "Multi""Sum"

      • qMiniChartDefobject
        Show qMiniChartDef properties
        • qDefstring

          Expression or field name.

        • qLibraryIdstring

          LibraryId for dimension.

        • qSortByobject
          Show qSortBy properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitobject
            Show qOtherLimit properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitModestring

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOtherboolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeepingboolean

            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

          • qApplyEvenWhenPossiblyWrongResultboolean

            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

          • qGlobalOtherGroupingboolean

            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

          • qOtherCollapseInnerDimensionsboolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortModestring

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qMaxNumberPointsinteger

          default = -1, format = int32, default = -1

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            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
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              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.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qNullSuppressionboolean

          If set to true, no null values are returned.
    • qNullSuppressionboolean

      If set to true, no null values are returned.

    • qOtherTotalSpecobject
      Show qOtherTotalSpec properties
      • qOtherModestring

        Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

      • qOtherCountedobject
        Show qOtherCounted properties
        • qvstring

          Expression evaluated to dual.
      • qOtherLimitobject
        Show qOtherLimit properties
        • qvstring

          Expression evaluated to dual.
      • qOtherLimitModestring

        Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

      • qSuppressOtherboolean

        If set to true, the group Others is not displayed as a dimension value. The default value is false.

        default = false

      • qForceBadValueKeepingboolean

        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

      • qApplyEvenWhenPossiblyWrongResultboolean

        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

      • qGlobalOtherGroupingboolean

        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

      • qOtherCollapseInnerDimensionsboolean

        If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

        default = false

      • qOtherSortModestring

        Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

      • qTotalModestring

        Can be one of: "TOTAL_OFF""TOTAL_EXPR"

      • qReferencedExpressionobject
        Show qReferencedExpression properties
        • qvstring

          Expression evaluated to string.
    • qShowAllboolean

      If set to true, all dimension values are shown.

    • qOtherLabelobject
      Show qOtherLabel properties
      • qvstring

        Expression evaluated to string.
    • qTotalLabelobject
      Show qTotalLabel properties
      • qvstring

        Expression evaluated to string.
    • qCalcConditionobject
      Show qCalcCondition properties
      • qCondobject
        Show qCond properties
        • qvstring

          Expression evaluated to dual.
      • qMsgobject
        Show qMsg properties
        • qvstring

          Expression evaluated to string.
    • qAttributeExpressionsarray of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpressionstring

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryIdstring

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttributeboolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabelstring

        Label of the attribute expression.

      • qLabelExpressionstring

        Optional expression used for dynamic label.
    • qAttributeDimensionsarray of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDefstring

        Expression or field name.

      • qLibraryIdstring

        LibraryId for dimension.

      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequencyinteger

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qAttributeboolean

        If set to true, this attribute will not affect the number of rows in the cube.
  • qInterColumnSortOrderarray 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.

  • qSuppressZeroboolean

    Removes zero values.

    default = false

  • qSuppressMissingboolean

    Removes missing values.

    default = false

  • qOpenFullyExpandedboolean

    If this property is set to true, the cells are opened expanded. The default value is false.

    default = false

  • qPopulateMissingboolean

    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

  • qCalcConditionobject
    Show qCalcCondition properties
    • qCondobject
      Show qCond properties
      • qvstring

        Expression evaluated to dual.
    • qMsgobject
      Show qMsg properties
      • qvstring

        Expression evaluated to string.
  • qTitleobject
    Show qTitle properties
    • qvstring

      Expression evaluated to string.
  • qInitialDataFetcharray of objects

    Initial data set. This property is optional.

    Show qInitialDataFetch properties
    • qMaxNbrOfNodesinteger

      Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

      format = int32

    • qTreeNodesarray of objects

      Defines areas of the tree to be fetched. Areas must be defined left to right.

      Show qTreeNodes properties
      • qAreaobject
        Show qArea properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          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

        • qHeightinteger

          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

      • qAllValuesboolean

        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.
    • qTreeLevelsobject
      Show qTreeLevels properties
      • qLeftinteger

        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

      • qDepthinteger

        Number of dimensions to include in the tree.

        default = -1, format = int32, default = -1

  • qExpansionStatearray of objects
    Experimental

    Expansion state per dimension.

    Show qExpansionState properties
    • qExcludeListboolean
    • qPosobject
      Show qPos properties
      • qDimNamestring
      • qElemNoarray of integers
      • qElemValuesarray of strings
  • qValueExprsarray of objects

    List of measures to calculate on the whole tree.

    Show qValueExprs properties
    • qLibraryIdstring

      Refers to a measure stored in the library.

    • qDefobject
      Show qDef properties
      • qLabelstring

        Name of the measure. An empty string is returned as a default value. This parameter is optional.

      • qDescriptionstring

        Description of the measure. An empty string is returned as a default value. This parameter is optional.

      • qTagsarray of strings

        Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

      • qGroupingstring

        Can be one of: "N""H""C"

      • qDefstring

        Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qRelativeboolean

        If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

      • qBrutalSumboolean

        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 .

      • qAggrFuncstring

        Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

      • qAccumulateinteger
        • 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

      • qReverseSortboolean

        If set to true, it inverts the sort criteria in the field.

      • qActiveExpressioninteger

        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

      • qExpressionsarray 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.

      • qLabelExpressionstring

        Label expression. This parameter is optional.
    • qSortByobject
      Show qSortBy properties
      • qSortByStateinteger

        Sorts the field values according to their logical state (selected, optional, alternative or excluded).

        format = int8

      • qSortByFrequencyinteger

        Sorts the field values by frequency (number of occurrences in the field).

        format = int8

      • qSortByNumericinteger

        Sorts the field values by numeric value.

        format = int8

      • qSortByAsciiinteger

        Sorts the field by alphabetical order.

        format = int8

      • qSortByLoadOrderinteger

        Sorts the field values by the initial load order.

        format = int8

      • qSortByExpressioninteger

        Sorts the field by expression.

        format = int8

      • qExpressionobject
        Show qExpression properties
        • qvstring

          Expression evaluated to dual.
      • qSortByGreynessinteger

        format = int8

    • qAttributeExpressionsarray of objects

      List of attribute expressions.

      Show qAttributeExpressions properties
      • qExpressionstring

        Definition of the attribute expression. Example: "Max(OrderID)"

      • qLibraryIdstring

        Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

      • qAttributeboolean

        If set to true, this measure will not affect the number of rows in the cube.

      • qNumFormatobject

        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
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          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.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qLabelstring

        Label of the attribute expression.

      • qLabelExpressionstring

        Optional expression used for dynamic label.
    • qAttributeDimensionsarray of objects

      List of attribute dimensions.

      Show qAttributeDimensions properties
      • qDefstring

        Expression or field name.

      • qLibraryIdstring

        LibraryId for dimension.

      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequencyinteger

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qAttributeboolean

        If set to true, this attribute will not affect the number of rows in the cube.
    • qCalcCondobject
      Show qCalcCond properties
      • qvstring

        Expression evaluated to dual.
    • qCalcConditionobject
      Show qCalcCondition properties
      • qCondobject
        Show qCond properties
        • qvstring

          Expression evaluated to dual.
      • qMsgobject
        Show qMsg properties
        • qvstring

          Expression evaluated to string.
    • qTrendLinesarray of objects
      Experimental

      Specifies trendlines for this measure.

      Show qTrendLines properties
      • qTypestring

        Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

      • qXColIxinteger

        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

      • qCalcR2boolean

        Set to true to calulatate the R2 score

        default = false

      • qContinuousXAxisstring

        Can be one of: "Never""Possible""Time"

      • qMultiDimModestring

        Can be one of: "Multi""Sum"

    • qMiniChartDefobject
      Show qMiniChartDef properties
      • qDefstring

        Expression or field name.

      • qLibraryIdstring

        LibraryId for dimension.

      • qSortByobject
        Show qSortBy properties
        • qSortByStateinteger

          Sorts the field values according to their logical state (selected, optional, alternative or excluded).

          format = int8

        • qSortByFrequencyinteger

          Sorts the field values by frequency (number of occurrences in the field).

          format = int8

        • qSortByNumericinteger

          Sorts the field values by numeric value.

          format = int8

        • qSortByAsciiinteger

          Sorts the field by alphabetical order.

          format = int8

        • qSortByLoadOrderinteger

          Sorts the field values by the initial load order.

          format = int8

        • qSortByExpressioninteger

          Sorts the field by expression.

          format = int8

        • qExpressionobject
          Show qExpression properties
          • qvstring

            Expression evaluated to dual.
        • qSortByGreynessinteger

          format = int8

      • qOtherTotalSpecobject
        Show qOtherTotalSpec properties
        • qOtherModestring

          Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

        • qOtherCountedobject
          Show qOtherCounted properties
          • qvstring

            Expression evaluated to dual.
        • qOtherLimitobject
          Show qOtherLimit properties
          • qvstring

            Expression evaluated to dual.
        • qOtherLimitModestring

          Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

        • qSuppressOtherboolean

          If set to true, the group Others is not displayed as a dimension value. The default value is false.

          default = false

        • qForceBadValueKeepingboolean

          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

        • qApplyEvenWhenPossiblyWrongResultboolean

          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

        • qGlobalOtherGroupingboolean

          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

        • qOtherCollapseInnerDimensionsboolean

          If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

          default = false

        • qOtherSortModestring

          Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

        • qTotalModestring

          Can be one of: "TOTAL_OFF""TOTAL_EXPR"

        • qReferencedExpressionobject
          Show qReferencedExpression properties
          • qvstring

            Expression evaluated to string.
      • qMaxNumberPointsinteger

        default = -1, format = int32, default = -1

      • qAttributeExpressionsarray of objects

        List of attribute expressions.

        Show qAttributeExpressions properties
        • qExpressionstring

          Definition of the attribute expression. Example: "Max(OrderID)"

        • qLibraryIdstring

          Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

        • qAttributeboolean

          If set to true, this measure will not affect the number of rows in the cube.

        • qNumFormatobject

          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
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            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.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qLabelstring

          Label of the attribute expression.

        • qLabelExpressionstring

          Optional expression used for dynamic label.
      • qNullSuppressionboolean

        If set to true, no null values are returned.
  • qContextSetExpressionstring

    Set Expression valid for the whole cube. Used to limit computations to the set specified.

schemas UndoInfo object

Displays information about the number of possible undos and redos. Is the layout for UndoInfoDef.

Properties

  • qUndoCountinteger

    Number of possible undos.

    format = int32

  • qRedoCountinteger

    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

schemas ValueExpr object

Properties

  • qvstring

    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

  • qExprstring

schemas VariableList object

Lists the variables in an app. Is the layout for VariableListDef.

Properties

  • qItemsarray of objects

    List of the variables.

    Show qItems properties
    • qNamestring

      Name of the variable.

    • qDescriptionstring

      Description of the variable.

    • qDefinitionstring

      Definition of the variable. It can be a value or an expression.

    • qIsConfigboolean

      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

    • qIsReservedboolean

      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

    • qMetaobject

      Layout for NxMetaDef.

      Show qMeta properties
      • qNamestring

        Name. This property is optional.
    • qInfoobject
      Show qInfo properties
      • qIdstring

        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.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qDataobject

      Contains dynamic JSON data specified by the client.

    • qIsScriptCreatedboolean

      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

  • qTypestring

    Type of variables to include in the list.

  • qShowReservedboolean

    Shows the reserved variables if set to true.

  • qShowConfigboolean

    Shows the system variables if set to true.

  • qDataobject

    Contains dynamic JSON data specified by the client.

  • qShowSessionboolean

    Shows the session variables if set to true.