Qlik Sense Engine (qix)

Download OpenRPC spec

GenericObject

GenericObject AbortListObjectSearch

(qPath)

Aborts the results of a search in a list object.

This method applies to list objects (objects with one dimension).
After an abort on a list object search, the _GetLayout Method_ does not return any more search results but it does return the values in the field.

Parameters

  • qPath string
    Required

    Path to the definition of the list object. For example, /qListObjectDef .

Response

object

Errors

array
GenericErrors

AbortListObjectSearch(qPath)

enigma.js
const result = await genericObject.abortListObjectSearch("value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "AbortListObjectSearch",
  "params": {
    "qPath": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject AcceptListObjectSearch

(qPath, qToggleMode, qSoftLock?)

Accept the results of a search in a list object. The search results become selected in the field.

This method applies to list objects (objects with one dimension).
The search results are displayed using the _GetLayout Method_.

Parameters

  • qPath string
    Required

    Path to the definition of the list object. For example, /qListObjectDef .

  • qToggleMode boolean
    Required

    Set to true to keep any selections present in the list object. If this parameter is set to false, selections made before accepting the list object search become alternative.

  • qSoftLock boolean

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

Response

object

Errors

array
GenericErrors

AcceptListObjectSearch(qPath, qToggleMode, qSoftLock?)

enigma.js
const result = await genericObject.acceptListObjectSearch("value", true, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "AcceptListObjectSearch",
  "params": {
    "qPath": "value",
    "qToggleMode": true,
    "qSoftLock": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject AddGroupMembers

(qPath, qMembers, qTargetGroupId?, qPosId?)
Experimental

You can use the AddGroupMembers method with any object that contains an object grouping definition. This method allows you to add one or more members to an existing group of objects directly.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For exampleb /qNxGroupDef .

  • qMembers array of objects
    Required Experimental

    Array of IDs for the objects and/or subgroups to add to the group.

    Show qMembers properties
    • qGroupId string
    • qObjectId string
  • qTargetGroupId string

    Name of the group the Members will be added to (if not the called object).

  • qPosId string

    Id of the member whose position to insert into.

Response

object

Errors

array
GenericErrors

AddGroupMembers(qPath, qMembers, qTargetGroupId?, qPosId?)

enigma.js
const result = await genericObject.addGroupMembers("value", [
  {
    "qGroupId": "value",
    "qObjectId": "value"
  }
], "value", "value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "AddGroupMembers",
  "params": {
    "qPath": "value",
    "qMembers": [
      {
        "qGroupId": "value",
        "qObjectId": "value"
      }
    ],
    "qTargetGroupId": "value",
    "qPosId": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject ApplyPatches

(qPatches, qSoftPatch?)

Applies a patch to the properties of an object. Allows an update to some of the properties. It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch. In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties , and only a GetLayout call shows the result of the operation. Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future.

Soft properties apply only to generic objects.

Parameters

  • qPatches array of objects
    Required

    Array of patches.

    Show qPatches properties
    • qOp string

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

    • qPath string

      Path to the property to add, remove or replace.

    • qValue string

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

    If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch. The default value is false.

Response

object

Errors

array
GenericErrors

ApplyPatches(qPatches, qSoftPatch?)

enigma.js
const result = await genericObject.applyPatches([
  {
    "qOp": "add",
    "qPath": "value",
    "qValue": "value"
  }
], true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ApplyPatches",
  "params": {
    "qPatches": [
      {
        "qOp": "add",
        "qPath": "value",
        "qValue": "value"
      }
    ],
    "qSoftPatch": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject Approve

()

Adds the generic object to the list of approved objects

This operation is possible only in Qlik Sense Enterprise.

Response

object

Errors

array
GenericErrors

Approve()

enigma.js
const result = await genericObject.approve()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "Approve"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject BeginSelections

(qPaths)

Begins the selection mode. The app enters the modal state. The specified object enters the selection mode and a modal window is opened. The selection mode can apply to only one object in an app at a time. When a visualization is in selection mode, selections can be made in this visualization. The visualization is not sorted until the selection mode is ended. Once the selection mode is ended and if the selections are accepted, the visualization is sorted according to the sort criteria. For more information about:

  • Ending the selection mode, see EndSelections Method.
  • The sort criteria, see ListObjectDef or HyperCubeDef.

Example

A sheet contains a list object and a chart. If the list object is in selection mode then the chart cannot be in selection mode. No selection on the chart can be made until the list object exits the selection mode.

Parameters

  • qPaths array of strings
    Required

    List of the paths to the definition of the objects to enter selection mode. For example, /qListObjectDef .

Response

object

Errors

array
GenericErrors

BeginSelections(qPaths)

enigma.js
const result = await genericObject.beginSelections([
  "value"
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "BeginSelections",
  "params": {
    "qPaths": [
      "value"
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject ClearSelections

(qPath, qColIndices?)

Clears the selections in a dimension of a visualization.

Parameters

  • qPath string
    Required

    Path to the definition of the visualization. For example, /qListObjectDef .

  • qColIndices array of integers

    Array of dimension numbers or indexes. The selections are cleared in the specified dimensions. Dimension numbers/indexes start from 0. If this parameter is not set, all dimensions are cleared.

Response

object

Errors

array
GenericErrors

ClearSelections(qPath, qColIndices?)

enigma.js
const result = await genericObject.clearSelections("value", [
  123
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ClearSelections",
  "params": {
    "qPath": "value",
    "qColIndices": [
      123
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject ClearSoftPatches

()

Clears the soft properties of a generic object. For more information on how to add soft properties to a generic object, see ApplyPatches Method.

Response

object

Errors

array
GenericErrors

ClearSoftPatches()

enigma.js
const result = await genericObject.clearSoftPatches()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ClearSoftPatches"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject CollapseLeft

(qPath, qRow, qCol, qAll)

Collapses the left dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded. In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be collapsed. For example, /qHyperCubeDef .

  • qRow integer
    Required

    Row index in the data matrix. Indexing starts from 0.

  • qCol integer
    Required

    Column index. The index is based on the left dimension indexes. Indexing starts from 0.

  • qAll boolean
    Required

    If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

Response

object

Errors

array
GenericErrors

CollapseLeft(qPath, qRow, qCol, qAll)

enigma.js
const result = await genericObject.collapseLeft("value", 123, 123, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "CollapseLeft",
  "params": {
    "qPath": "value",
    "qRow": 123,
    "qCol": 123,
    "qAll": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject CollapseTop

(qPath, qRow, qCol, qAll)

Collapses the top dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded. In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be collapsed For example, /qHyperCubeDef .

  • qRow integer
    Required

    Row index. The index is based on the top dimension indexes. Indexing starts from 0.

  • qCol integer
    Required

    Column index in the data matrix. Indexing starts from 0.

  • qAll boolean
    Required

    If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

Response

object

Errors

array
GenericErrors

CollapseTop(qPath, qRow, qCol, qAll)

enigma.js
const result = await genericObject.collapseTop("value", 123, 123, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "CollapseTop",
  "params": {
    "qPath": "value",
    "qRow": 123,
    "qCol": 123,
    "qAll": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject CopyFrom

(qFromId)

Copies the properties of a generic object and its children. The source object is specified by the parameter qFromId and the destination object is referenced by its handle.

The identifier of the destination object is the same as before the copy takes place.

Parameters

  • qFromId string
    Required

    Identifier of the object to copy.

Response

object

Errors

array
GenericErrors

CopyFrom(qFromId)

enigma.js
const result = await genericObject.copyFrom("value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "CopyFrom",
  "params": {
    "qFromId": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject CreateChild

(qProp, qPropForThis?)

Creates a generic object that is a child of another generic object.

It is possible to update the properties of the child's parent at the same time that the child is created. Both operations are performed by the same call.
It is possible to create a child that is linked to another generic object. The two objects have the same properties.

Parameters

  • qProp object
    Required

    Information about the child. It is possible to create a child that is linked to another object.

    Show qProp properties
    • qInfo object
      Show qInfo properties
      • qId string

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

      • qType string

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

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

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qStateName string

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

    • qAppObjectListDef object

      Defines the list of objects in an app.

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

        Type of the app list.

      • qData object

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

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qIncludePatches boolean

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

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

      Show qChildListDef properties
      • qData object

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

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qType string

        Type of the list.

      • qData object

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

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDef object

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDef object

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystem boolean

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

        default = false

      • qShowHidden boolean

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

        default = false

      • qShowSemantic boolean

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

        default = false

      • qShowSrcTables boolean

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

        default = false

      • qShowDefinitionOnly boolean

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

        default = false

      • qShowDerivedFields boolean

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

        default = false

      • qShowImplicit boolean

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

        default = false

    • qHyperCubeDef object

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

      Show qHyperCubeDef properties
      • qStateName string

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

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

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

          • qFieldDefs array of strings

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

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

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

            Show qSortCriterias properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

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

            Show qNumberPresentations properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

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

          • qActiveField integer

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

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qNullSuppression boolean

          If set to true, no null values are returned.

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

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

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

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

              Expression evaluated to dual.
          • qOtherLimitMode string

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

          • qSuppressOther boolean

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

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

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

            default = true

          • qGlobalOtherGrouping boolean

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

            default = false

          • qOtherCollapseInnerDimensions boolean

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

            default = false

          • qOtherSortMode string

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

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowTotal boolean
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

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

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

            Expression evaluated to dual.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

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

          • qLibraryId string

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

          • qAttribute boolean

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

            Label of the attribute expression.

          • qLabelExpression string

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

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

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

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

              Expression evaluated to string.
      • qMeasures array of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

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

          • qDescription string

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

          • qTags array of strings

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

          • qGrouping string

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

          • qDef string

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

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

          • qBrutalSum boolean

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

          • qAggrFunc string

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

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

            format = int32

          • qReverseSort boolean

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

          • qActiveExpression integer

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

            format = int32

          • qExpressions array of strings

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

          • qLabelExpression string

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

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

            format = int8

          • qSortByFrequency integer

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

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

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

          • qLibraryId string

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

          • qAttribute boolean

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

            Label of the attribute expression.

          • qLabelExpression string

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

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

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

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

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

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

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

          • qXColIx integer

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

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

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

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

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

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

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

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

                Expression evaluated to dual.
            • qOtherLimitMode string

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

            • qSuppressOther boolean

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

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

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

              default = true

            • qGlobalOtherGrouping boolean

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

              default = false

            • qOtherCollapseInnerDimensions boolean

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

              default = false

            • qOtherSortMode string

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

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

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

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

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

            • qLibraryId string

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

            • qAttribute boolean

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

            • qNumFormat object

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

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

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

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

                default = 0, format = int32, default = 0

              • qFmt string

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

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

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

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

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

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

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qInitialDataFetch array of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

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

          format = int32

        • qHeight integer

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

          format = int32

      • qReductionMode string

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

      • qMode string

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

      • qPseudoDimPos integer

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

      • qNoOfLeftDims integer

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

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

        implies that:

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

        Another example:

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

        Implies that:

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

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

      • qAlwaysFullyExpanded boolean

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

        default = false

      • qMaxStackedCells integer

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

        default = 5000, format = int32, default = 5000

      • qPopulateMissing boolean

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

        default = false

      • qShowTotalsAbove boolean

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

        default = false

      • qIndentMode boolean

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

        default = false

      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qSortbyYValue integer

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

        default = 0, format = int8, default = 0

      • qTitle object
        Show qTitle properties
        • qv string

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

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

            Expression evaluated to string.
      • qColumnOrder array of integers

        The order of the columns.

      • qExpansionState array of objects
        Experimental

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

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

        Hypercube Modifier Dynamic script string

      • qContextSetExpression string

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

      • qSuppressMeasureTotals boolean

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

      Contains JSON to be excluded from validation.

    • qListObjectDef object

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

      Show qListObjectDef properties
      • qStateName string

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

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

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

        • qFieldDefs array of strings

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

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

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

          Show qSortCriterias properties
          • qSortByState integer

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

            format = int8

          • qSortByFrequency integer

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

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

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

          Show qNumberPresentations properties
          • qType string

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

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

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

            default = 0, format = int32, default = 0

          • qFmt string

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

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

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

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

        • qActiveField integer

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

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

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

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

          format = int32

      • qFrequencyMode string

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

      • qShowAlternatives boolean

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

      • qInitialDataFetch array of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

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

          format = int32

        • qHeight integer

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

          format = int32

      • qExpressions array of objects

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

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qLibraryId string

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

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

      Defines the list of measures.

      Show qMeasureListDef properties
      • qType string

        Type of the list.

      • qData object

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

      Defines the list of media files.

      This struct is deprecated.

      Properties

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

    • qNxLibraryDimensionDef object
      Show qNxLibraryDimensionDef properties
      • qGrouping string

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

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

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

    • qNxLibraryMeasureDef object
      Show qNxLibraryMeasureDef properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

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

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

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

        Formatting mechanism

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

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

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

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

        Type is INTEGER

        The following applies:

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

        Type is REAL

        The following applies:

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

        Type is FIX

        The following applies:

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

        Type is MONEY

        The following applies:

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

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

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

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

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

          default = 0, format = int32, default = 0

        • qFmt string

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

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

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

        default = false

      • qOrigin string

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

    • qSelectionObjectDef object

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

      Properties

      "qSelectionObjectDef": {}

      Show qSelectionObjectDef properties
      • qStateName string

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

        Relative path of the thumbnail.
    • qStringExpression object

      Properties

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

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

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

      Show qTreeDataDef properties
      • qStateName string

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

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

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

          • qFieldDefs array of strings

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

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

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

            Show qSortCriterias properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

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

            Show qNumberPresentations properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

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

          • qActiveField integer

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

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qValueExprs array of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

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

            • qDescription string

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

            • qTags array of strings

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

            • qGrouping string

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

            • qDef string

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

            • qNumFormat object

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

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

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

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

                default = 0, format = int32, default = 0

              • qFmt string

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

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

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

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

            • qBrutalSum boolean

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

            • qAggrFunc string

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

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

              format = int32

            • qReverseSort boolean

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

            • qActiveExpression integer

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

              format = int32

            • qExpressions array of strings

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

            • qLabelExpression string

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

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

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

            • qLibraryId string

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

            • qAttribute boolean

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

            • qNumFormat object

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

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

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

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

                default = 0, format = int32, default = 0

              • qFmt string

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

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

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

              Label of the attribute expression.

            • qLabelExpression string

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

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

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

                format = int8

              • qSortByFrequency integer

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

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

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

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

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

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

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

            • qXColIx integer

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

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

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

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

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

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

                format = int8

              • qSortByFrequency integer

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

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

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

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

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

                  Expression evaluated to dual.
              • qOtherLimitMode string

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

              • qSuppressOther boolean

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

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

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

                default = true

              • qGlobalOtherGrouping boolean

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

                default = false

              • qOtherCollapseInnerDimensions boolean

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

                default = false

              • qOtherSortMode string

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

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

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

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

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

              • qLibraryId string

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

              • qAttribute boolean

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

              • qNumFormat object

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

                Formatting mechanism

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

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

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

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

                Type is INTEGER

                The following applies:

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

                Type is REAL

                The following applies:

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

                Type is FIX

                The following applies:

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

                Type is MONEY

                The following applies:

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

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

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

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

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

                  default = 0, format = int32, default = 0

                • qFmt string

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

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

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

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

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

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

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

              Expression evaluated to dual.
          • qOtherLimitMode string

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

          • qSuppressOther boolean

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

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

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

            default = true

          • qGlobalOtherGrouping boolean

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

            default = false

          • qOtherCollapseInnerDimensions boolean

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

            default = false

          • qOtherSortMode string

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

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

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

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

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

              Expression evaluated to string.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

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

          • qLibraryId string

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

          • qAttribute boolean

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

            Label of the attribute expression.

          • qLabelExpression string

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

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrder array of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qOpenFullyExpanded boolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissing boolean

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

        default = false

      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

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

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

          Expression evaluated to string.
      • qInitialDataFetch array of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodes integer

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodes array of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qArea object
            Show qArea properties
            • qLeft integer

              Position from the left. Corresponds to the first column.

              format = int32

            • qTop integer

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidth integer

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

              format = int32

            • qHeight integer

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

              format = int32

          • qAllValues boolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevels object
          Show qTreeLevels properties
          • qLeft integer

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepth integer

            Number of dimensions to include in the tree.

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

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension.

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

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

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

          • qDescription string

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

          • qTags array of strings

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

          • qGrouping string

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

          • qDef string

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

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

          • qBrutalSum boolean

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

          • qAggrFunc string

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

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

            format = int32

          • qReverseSort boolean

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

          • qActiveExpression integer

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

            format = int32

          • qExpressions array of strings

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

          • qLabelExpression string

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

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

            format = int8

          • qSortByFrequency integer

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

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

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

          • qLibraryId string

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

          • qAttribute boolean

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

            Label of the attribute expression.

          • qLabelExpression string

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

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

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

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

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

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

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

          • qXColIx integer

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

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

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

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

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

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

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

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

                Expression evaluated to dual.
            • qOtherLimitMode string

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

            • qSuppressOther boolean

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

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

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

              default = true

            • qGlobalOtherGrouping boolean

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

              default = false

            • qOtherCollapseInnerDimensions boolean

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

              default = false

            • qOtherSortMode string

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

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

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

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

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

            • qLibraryId string

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

            • qAttribute boolean

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

            • qNumFormat object

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

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

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

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

                default = 0, format = int32, default = 0

              • qFmt string

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

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

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

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qContextSetExpression string

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

      Defines if an object should contain information on the number of possible undo and redo.

      Properties

      "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

    • qValueExpression object

      Properties

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

      • < expression > is a string.
      The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      The expression is evaluated as a numeric.
      Show qValueExpression properties
      • qExpr string
    • qVariableListDef object

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qType string

        Type of variables to include in the list.

      • qShowReserved boolean

        Shows the reserved variables if set to true.

      • qShowConfig boolean

        Shows the system variables if set to true.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qShowSession boolean

        Shows the session variables if set to true.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
  • qPropForThis object

    Identifier of the parent's object. Should be set to update the properties of the parent's object at the same time the child is created.

    Show qPropForThis properties
    • qInfo object
      Show qInfo properties
      • qId string

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

      • qType string

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

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

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qStateName string

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

    • qAppObjectListDef object

      Defines the list of objects in an app.

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

        Type of the app list.

      • qData object

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

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qIncludePatches boolean

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

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

      Show qChildListDef properties
      • qData object

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

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qType string

        Type of the list.

      • qData object

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

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDef object

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDef object

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystem boolean

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

        default = false

      • qShowHidden boolean

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

        default = false

      • qShowSemantic boolean

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

        default = false

      • qShowSrcTables boolean

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

        default = false

      • qShowDefinitionOnly boolean

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

        default = false

      • qShowDerivedFields boolean

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

        default = false

      • qShowImplicit boolean

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

        default = false

    • qHyperCubeDef object

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

      Show qHyperCubeDef properties
      • qStateName string

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

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

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

          • qFieldDefs array of strings

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

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

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

            Show qSortCriterias properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

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

            Show qNumberPresentations properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

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

          • qActiveField integer

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

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qNullSuppression boolean

          If set to true, no null values are returned.

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

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

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

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

              Expression evaluated to dual.
          • qOtherLimitMode string

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

          • qSuppressOther boolean

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

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

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

            default = true

          • qGlobalOtherGrouping boolean

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

            default = false

          • qOtherCollapseInnerDimensions boolean

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

            default = false

          • qOtherSortMode string

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

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowTotal boolean
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

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

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

            Expression evaluated to dual.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

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

          • qLibraryId string

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

          • qAttribute boolean

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

            Label of the attribute expression.

          • qLabelExpression string

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

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

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

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

              Expression evaluated to string.
      • qMeasures array of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

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

          • qDescription string

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

          • qTags array of strings

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

          • qGrouping string

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

          • qDef string

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

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

          • qBrutalSum boolean

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

          • qAggrFunc string

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

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

            format = int32

          • qReverseSort boolean

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

          • qActiveExpression integer

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

            format = int32

          • qExpressions array of strings

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

          • qLabelExpression string

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

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

            format = int8

          • qSortByFrequency integer

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

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

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

          • qLibraryId string

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

          • qAttribute boolean

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

            Label of the attribute expression.

          • qLabelExpression string

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

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

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

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

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

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

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

          • qXColIx integer

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

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

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

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

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

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

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

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

                Expression evaluated to dual.
            • qOtherLimitMode string

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

            • qSuppressOther boolean

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

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

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

              default = true

            • qGlobalOtherGrouping boolean

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

              default = false

            • qOtherCollapseInnerDimensions boolean

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

              default = false

            • qOtherSortMode string

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

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

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

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

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

            • qLibraryId string

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

            • qAttribute boolean

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

            • qNumFormat object

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

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

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

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

                default = 0, format = int32, default = 0

              • qFmt string

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

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

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

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

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

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

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qInitialDataFetch array of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

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

          format = int32

        • qHeight integer

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

          format = int32

      • qReductionMode string

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

      • qMode string

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

      • qPseudoDimPos integer

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

      • qNoOfLeftDims integer

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

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

        implies that:

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

        Another example:

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

        Implies that:

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

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

      • qAlwaysFullyExpanded boolean

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

        default = false

      • qMaxStackedCells integer

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

        default = 5000, format = int32, default = 5000

      • qPopulateMissing boolean

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

        default = false

      • qShowTotalsAbove boolean

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

        default = false

      • qIndentMode boolean

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

        default = false

      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qSortbyYValue integer

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

        default = 0, format = int8, default = 0

      • qTitle object
        Show qTitle properties
        • qv string

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

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

            Expression evaluated to string.
      • qColumnOrder array of integers

        The order of the columns.

      • qExpansionState array of objects
        Experimental

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

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

        Hypercube Modifier Dynamic script string

      • qContextSetExpression string

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

      • qSuppressMeasureTotals boolean

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

      Contains JSON to be excluded from validation.

    • qListObjectDef object

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

      Show qListObjectDef properties
      • qStateName string

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

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

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

        • qFieldDefs array of strings

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

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

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

          Show qSortCriterias properties
          • qSortByState integer

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

            format = int8

          • qSortByFrequency integer

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

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

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

          Show qNumberPresentations properties
          • qType string

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

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

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

            default = 0, format = int32, default = 0

          • qFmt string

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

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

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

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

        • qActiveField integer

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

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

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

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

          format = int32

      • qFrequencyMode string

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

      • qShowAlternatives boolean

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

      • qInitialDataFetch array of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

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

          format = int32

        • qHeight integer

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

          format = int32

      • qExpressions array of objects

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

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qLibraryId string

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

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

      Defines the list of measures.

      Show qMeasureListDef properties
      • qType string

        Type of the list.

      • qData object

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

      Defines the list of media files.

      This struct is deprecated.

      Properties

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

    • qNxLibraryDimensionDef object
      Show qNxLibraryDimensionDef properties
      • qGrouping string

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

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

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

    • qNxLibraryMeasureDef object
      Show qNxLibraryMeasureDef properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

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

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

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

        Formatting mechanism

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

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

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

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

        Type is INTEGER

        The following applies:

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

        Type is REAL

        The following applies:

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

        Type is FIX

        The following applies:

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

        Type is MONEY

        The following applies:

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

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

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

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

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

          default = 0, format = int32, default = 0

        • qFmt string

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

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

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

        default = false

      • qOrigin string

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

    • qSelectionObjectDef object

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

      Properties

      "qSelectionObjectDef": {}

      Show qSelectionObjectDef properties
      • qStateName string

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

        Relative path of the thumbnail.
    • qStringExpression object

      Properties

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

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

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

      Show qTreeDataDef properties
      • qStateName string

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

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

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

          • qFieldDefs array of strings

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

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

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

            Show qSortCriterias properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

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

            Show qNumberPresentations properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

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

          • qActiveField integer

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

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qValueExprs array of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

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

            • qDescription string

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

            • qTags array of strings

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

            • qGrouping string

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

            • qDef string

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

            • qNumFormat object

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

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

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

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

                default = 0, format = int32, default = 0

              • qFmt string

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

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

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

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

            • qBrutalSum boolean

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

            • qAggrFunc string

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

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

              format = int32

            • qReverseSort boolean

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

            • qActiveExpression integer

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

              format = int32

            • qExpressions array of strings

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

            • qLabelExpression string

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

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

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

            • qLibraryId string

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

            • qAttribute boolean

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

            • qNumFormat object

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

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

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

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

                default = 0, format = int32, default = 0

              • qFmt string

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

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

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

              Label of the attribute expression.

            • qLabelExpression string

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

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

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

                format = int8

              • qSortByFrequency integer

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

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

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

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

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

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

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

            • qXColIx integer

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

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

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

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

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

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

                format = int8

              • qSortByFrequency integer

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

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

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

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

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

                  Expression evaluated to dual.
              • qOtherLimitMode string

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

              • qSuppressOther boolean

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

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

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

                default = true

              • qGlobalOtherGrouping boolean

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

                default = false

              • qOtherCollapseInnerDimensions boolean

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

                default = false

              • qOtherSortMode string

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

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

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

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

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

              • qLibraryId string

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

              • qAttribute boolean

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

              • qNumFormat object

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

                Formatting mechanism

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

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

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

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

                Type is INTEGER

                The following applies:

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

                Type is REAL

                The following applies:

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

                Type is FIX

                The following applies:

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

                Type is MONEY

                The following applies:

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

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

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

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

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

                  default = 0, format = int32, default = 0

                • qFmt string

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

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

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

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

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

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

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

              Expression evaluated to dual.
          • qOtherLimitMode string

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

          • qSuppressOther boolean

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

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

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

            default = true

          • qGlobalOtherGrouping boolean

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

            default = false

          • qOtherCollapseInnerDimensions boolean

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

            default = false

          • qOtherSortMode string

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

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

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

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

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

              Expression evaluated to string.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

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

          • qLibraryId string

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

          • qAttribute boolean

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

            Label of the attribute expression.

          • qLabelExpression string

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

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

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

              format = int8

            • qSortByFrequency integer

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

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrder array of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qOpenFullyExpanded boolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissing boolean

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

        default = false

      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

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

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

          Expression evaluated to string.
      • qInitialDataFetch array of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodes integer

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodes array of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qArea object
            Show qArea properties
            • qLeft integer

              Position from the left. Corresponds to the first column.

              format = int32

            • qTop integer

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidth integer

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

              format = int32

            • qHeight integer

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

              format = int32

          • qAllValues boolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevels object
          Show qTreeLevels properties
          • qLeft integer

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepth integer

            Number of dimensions to include in the tree.

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

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension.

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

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

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

          • qDescription string

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

          • qTags array of strings

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

          • qGrouping string

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

          • qDef string

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

          • qNumFormat object

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

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

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

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

              default = 0, format = int32, default = 0

            • qFmt string

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

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

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

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

          • qBrutalSum boolean

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

          • qAggrFunc string

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

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

            format = int32

          • qReverseSort boolean

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

          • qActiveExpression integer

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

            format = int32

          • qExpressions array of strings

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

          • qLabelExpression string

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

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

            format = int8

          • qSortByFrequency integer

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

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

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

          • qLibraryId string

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

          • qAttribute boolean

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

          • qNumFormat object

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

            Formatting mechanism

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

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.
    • qUndoInfoDef object

      Defines if an object should contain information on the number of possible undo and redo.

      Properties

      "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

    • qValueExpression object

      Properties

      Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string.
      The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      The expression is evaluated as a numeric.
      Show qValueExpression properties
      • qExpr string
    • qVariableListDef object

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qType string

        Type of variables to include in the list.

      • qShowReserved boolean

        Shows the reserved variables if set to true.

      • qShowConfig boolean

        Shows the system variables if set to true.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qShowSession boolean

        Shows the session variables if set to true.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object

Response

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.
  • qReturn object
    Show qReturn properties
    • qType string

      The native type of the object.

    • qHandle integer

      The handle used to connect to object.

      format = int32

    • qGenericType string

      The type of the object.

    • qGenericId string

      Object ID.

Errors

array
GenericErrors

CreateChild(qProp, qPropForThis?)

enigma.js
const result = await genericObject.createChild({
  "qInfo": {
    "qId": "value",
    "qType": "value"
  },
  "qExtendsId": "value",
  "qMetaDef": {},
  "qStateName": "value",
  "qAppObjectListDef": {
    "qType": "value",
    "qData": {}
  },
  "qBookmarkListDef": {
    "qType": "value",
    "qData": {},
    "qIncludePatches": true
  },
  "qChildListDef": {
    "qData": {}
  },
  "qDimensionListDef": {
    "qType": "value",
    "qData": {}
  },
  "qEmbeddedSnapshotDef": {},
  "qExtensionListDef": {},
  "qFieldListDef": {
    "qShowSystem": false,
    "qShowHidden": false,
    "qShowSemantic": false,
    "qShowSrcTables": false,
    "qShowDefinitionOnly": false,
    "qShowDerivedFields": false,
    "qShowImplicit": false
  },
  "qHyperCubeDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qNullSuppression": true,
        "qIncludeElemValue": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowTotal": true,
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCond": {
          "qv": "value"
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        }
      }
    ],
    "qMeasures": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qReductionMode": "N",
    "qMode": "S",
    "qPseudoDimPos": -1,
    "qNoOfLeftDims": -1,
    "qAlwaysFullyExpanded": false,
    "qMaxStackedCells": 5000,
    "qPopulateMissing": false,
    "qShowTotalsAbove": false,
    "qIndentMode": false,
    "qCalcCond": {
      "qv": "value"
    },
    "qSortbyYValue": 0,
    "qTitle": {
      "qv": "value"
    },
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qColumnOrder": [
      123
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qDynamicScript": [
      "value"
    ],
    "qContextSetExpression": "value",
    "qSuppressMeasureTotals": true
  },
  "qLayoutExclude": {},
  "qListObjectDef": {
    "qStateName": "value",
    "qLibraryId": "value",
    "qDef": {
      "qGrouping": "N",
      "qFieldDefs": [
        "value"
      ],
      "qFieldLabels": [
        "value"
      ],
      "qSortCriterias": [
        {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        }
      ],
      "qNumberPresentations": [
        {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        }
      ],
      "qReverseSort": true,
      "qActiveField": 123,
      "qLabelExpression": "value",
      "qAlias": "value"
    },
    "qAutoSortByState": {
      "qDisplayNumberOfRows": 123
    },
    "qFrequencyMode": "N",
    "qShowAlternatives": true,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qExpressions": [
      {
        "qExpr": "value",
        "qLibraryId": "value"
      }
    ],
    "qDirectQuerySimplifiedView": true
  },
  "qMeasureListDef": {
    "qType": "value",
    "qData": {}
  },
  "qMediaListDef": {},
  "qNxLibraryDimensionDef": {
    "qGrouping": "N",
    "qFieldDefs": [
      "value"
    ],
    "qFieldLabels": [
      "value"
    ],
    "qLabelExpression": "value",
    "qAlias": "value",
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qNxLibraryMeasureDef": {
    "qLabel": "value",
    "qDef": "value",
    "qGrouping": "N",
    "qExpressions": [
      "value"
    ],
    "qActiveExpression": 123,
    "qLabelExpression": "value",
    "qNumFormat": {
      "qType": "U",
      "qnDec": 10,
      "qUseThou": 0,
      "qFmt": "value",
      "qDec": "value",
      "qThou": "value"
    },
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qSelectionObjectDef": {
    "qStateName": "value"
  },
  "qStaticContentUrlDef": {
    "qUrl": "value"
  },
  "qStringExpression": {
    "qExpr": "value"
  },
  "qTreeDataDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qNullSuppression": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ]
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qOpenFullyExpanded": false,
    "qPopulateMissing": false,
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qTitle": {
      "qv": "value"
    },
    "qInitialDataFetch": [
      {
        "qMaxNbrOfNodes": 123,
        "qTreeNodes": [
          {
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            },
            "qAllValues": true
          }
        ],
        "qTreeLevels": {
          "qLeft": 123,
          "qDepth": -1
        }
      }
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qValueExprs": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qContextSetExpression": "value"
  },
  "qUndoInfoDef": {},
  "qValueExpression": {
    "qExpr": "value"
  },
  "qVariableListDef": {
    "qType": "value",
    "qShowReserved": true,
    "qShowConfig": true,
    "qData": {},
    "qShowSession": true
  }
}, {
  "qInfo": {
    "qId": "value",
    "qType": "value"
  },
  "qExtendsId": "value",
  "qMetaDef": {},
  "qStateName": "value",
  "qAppObjectListDef": {
    "qType": "value",
    "qData": {}
  },
  "qBookmarkListDef": {
    "qType": "value",
    "qData": {},
    "qIncludePatches": true
  },
  "qChildListDef": {
    "qData": {}
  },
  "qDimensionListDef": {
    "qType": "value",
    "qData": {}
  },
  "qEmbeddedSnapshotDef": {},
  "qExtensionListDef": {},
  "qFieldListDef": {
    "qShowSystem": false,
    "qShowHidden": false,
    "qShowSemantic": false,
    "qShowSrcTables": false,
    "qShowDefinitionOnly": false,
    "qShowDerivedFields": false,
    "qShowImplicit": false
  },
  "qHyperCubeDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qNullSuppression": true,
        "qIncludeElemValue": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowTotal": true,
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCond": {
          "qv": "value"
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        }
      }
    ],
    "qMeasures": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qReductionMode": "N",
    "qMode": "S",
    "qPseudoDimPos": -1,
    "qNoOfLeftDims": -1,
    "qAlwaysFullyExpanded": false,
    "qMaxStackedCells": 5000,
    "qPopulateMissing": false,
    "qShowTotalsAbove": false,
    "qIndentMode": false,
    "qCalcCond": {
      "qv": "value"
    },
    "qSortbyYValue": 0,
    "qTitle": {
      "qv": "value"
    },
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qColumnOrder": [
      123
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qDynamicScript": [
      "value"
    ],
    "qContextSetExpression": "value",
    "qSuppressMeasureTotals": true
  },
  "qLayoutExclude": {},
  "qListObjectDef": {
    "qStateName": "value",
    "qLibraryId": "value",
    "qDef": {
      "qGrouping": "N",
      "qFieldDefs": [
        "value"
      ],
      "qFieldLabels": [
        "value"
      ],
      "qSortCriterias": [
        {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        }
      ],
      "qNumberPresentations": [
        {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        }
      ],
      "qReverseSort": true,
      "qActiveField": 123,
      "qLabelExpression": "value",
      "qAlias": "value"
    },
    "qAutoSortByState": {
      "qDisplayNumberOfRows": 123
    },
    "qFrequencyMode": "N",
    "qShowAlternatives": true,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qExpressions": [
      {
        "qExpr": "value",
        "qLibraryId": "value"
      }
    ],
    "qDirectQuerySimplifiedView": true
  },
  "qMeasureListDef": {
    "qType": "value",
    "qData": {}
  },
  "qMediaListDef": {},
  "qNxLibraryDimensionDef": {
    "qGrouping": "N",
    "qFieldDefs": [
      "value"
    ],
    "qFieldLabels": [
      "value"
    ],
    "qLabelExpression": "value",
    "qAlias": "value",
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qNxLibraryMeasureDef": {
    "qLabel": "value",
    "qDef": "value",
    "qGrouping": "N",
    "qExpressions": [
      "value"
    ],
    "qActiveExpression": 123,
    "qLabelExpression": "value",
    "qNumFormat": {
      "qType": "U",
      "qnDec": 10,
      "qUseThou": 0,
      "qFmt": "value",
      "qDec": "value",
      "qThou": "value"
    },
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qSelectionObjectDef": {
    "qStateName": "value"
  },
  "qStaticContentUrlDef": {
    "qUrl": "value"
  },
  "qStringExpression": {
    "qExpr": "value"
  },
  "qTreeDataDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qNullSuppression": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ]
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qOpenFullyExpanded": false,
    "qPopulateMissing": false,
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qTitle": {
      "qv": "value"
    },
    "qInitialDataFetch": [
      {
        "qMaxNbrOfNodes": 123,
        "qTreeNodes": [
          {
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            },
            "qAllValues": true
          }
        ],
        "qTreeLevels": {
          "qLeft": 123,
          "qDepth": -1
        }
      }
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qValueExprs": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qContextSetExpression": "value"
  },
  "qUndoInfoDef": {},
  "qValueExpression": {
    "qExpr": "value"
  },
  "qVariableListDef": {
    "qType": "value",
    "qShowReserved": true,
    "qShowConfig": true,
    "qData": {},
    "qShowSession": true
  }
})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "CreateChild",
  "params": {
    "qProp": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qExtendsId": "value",
      "qMetaDef": {},
      "qStateName": "value",
      "qAppObjectListDef": {
        "qType": "value",
        "qData": {}
      },
      "qBookmarkListDef": {
        "qType": "value",
        "qData": {},
        "qIncludePatches": true
      },
      "qChildListDef": {
        "qData": {}
      },
      "qDimensionListDef": {
        "qType": "value",
        "qData": {}
      },
      "qEmbeddedSnapshotDef": {},
      "qExtensionListDef": {},
      "qFieldListDef": {
        "qShowSystem": false,
        "qShowHidden": false,
        "qShowSemantic": false,
        "qShowSrcTables": false,
        "qShowDefinitionOnly": false,
        "qShowDerivedFields": false,
        "qShowImplicit": false
      },
      "qHyperCubeDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qNullSuppression": true,
            "qIncludeElemValue": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowTotal": true,
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCond": {
              "qv": "value"
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            }
          }
        ],
        "qMeasures": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qReductionMode": "N",
        "qMode": "S",
        "qPseudoDimPos": -1,
        "qNoOfLeftDims": -1,
        "qAlwaysFullyExpanded": false,
        "qMaxStackedCells": 5000,
        "qPopulateMissing": false,
        "qShowTotalsAbove": false,
        "qIndentMode": false,
        "qCalcCond": {
          "qv": "value"
        },
        "qSortbyYValue": 0,
        "qTitle": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qColumnOrder": [
          123
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qDynamicScript": [
          "value"
        ],
        "qContextSetExpression": "value",
        "qSuppressMeasureTotals": true
      },
      "qLayoutExclude": {},
      "qListObjectDef": {
        "qStateName": "value",
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qAutoSortByState": {
          "qDisplayNumberOfRows": 123
        },
        "qFrequencyMode": "N",
        "qShowAlternatives": true,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qExpressions": [
          {
            "qExpr": "value",
            "qLibraryId": "value"
          }
        ],
        "qDirectQuerySimplifiedView": true
      },
      "qMeasureListDef": {
        "qType": "value",
        "qData": {}
      },
      "qMediaListDef": {},
      "qNxLibraryDimensionDef": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value",
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qNxLibraryMeasureDef": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qSelectionObjectDef": {
        "qStateName": "value"
      },
      "qStaticContentUrlDef": {
        "qUrl": "value"
      },
      "qStringExpression": {
        "qExpr": "value"
      },
      "qTreeDataDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qValueExprs": [
              {
                "qLibraryId": "value",
                "qDef": {
                  "qLabel": "value",
                  "qDescription": "value",
                  "qTags": [
                    "value"
                  ],
                  "qGrouping": "N",
                  "qDef": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qRelative": true,
                  "qBrutalSum": true,
                  "qAggrFunc": "value",
                  "qAccumulate": 123,
                  "qReverseSort": true,
                  "qActiveExpression": 123,
                  "qExpressions": [
                    "value"
                  ],
                  "qLabelExpression": "value"
                },
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qAttributeDimensions": [
                  {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qAttribute": true
                  }
                ],
                "qCalcCond": {
                  "qv": "value"
                },
                "qCalcCondition": {
                  "qCond": {
                    "qv": "value"
                  },
                  "qMsg": {
                    "qv": "value"
                  }
                },
                "qTrendLines": [
                  {
                    "qType": "AVERAGE",
                    "qXColIx": -1,
                    "qCalcR2": false,
                    "qContinuousXAxis": "Never",
                    "qMultiDimMode": "Multi"
                  }
                ],
                "qMiniChartDef": {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qOtherTotalSpec": {
                    "qOtherMode": "OTHER_OFF",
                    "qOtherCounted": {
                      "qv": "value"
                    },
                    "qOtherLimit": {
                      "qv": "value"
                    },
                    "qOtherLimitMode": "OTHER_GE_LIMIT",
                    "qSuppressOther": false,
                    "qForceBadValueKeeping": true,
                    "qApplyEvenWhenPossiblyWrongResult": true,
                    "qGlobalOtherGrouping": false,
                    "qOtherCollapseInnerDimensions": false,
                    "qOtherSortMode": "OTHER_SORT_DEFAULT",
                    "qTotalMode": "TOTAL_OFF",
                    "qReferencedExpression": {
                      "qv": "value"
                    }
                  },
                  "qMaxNumberPoints": -1,
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qNullSuppression": true
                }
              }
            ],
            "qNullSuppression": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ]
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qOpenFullyExpanded": false,
        "qPopulateMissing": false,
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTitle": {
          "qv": "value"
        },
        "qInitialDataFetch": [
          {
            "qMaxNbrOfNodes": 123,
            "qTreeNodes": [
              {
                "qArea": {
                  "qLeft": 123,
                  "qTop": 123,
                  "qWidth": 123,
                  "qHeight": 123
                },
                "qAllValues": true
              }
            ],
            "qTreeLevels": {
              "qLeft": 123,
              "qDepth": -1
            }
          }
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qContextSetExpression": "value"
      },
      "qUndoInfoDef": {},
      "qValueExpression": {
        "qExpr": "value"
      },
      "qVariableListDef": {
        "qType": "value",
        "qShowReserved": true,
        "qShowConfig": true,
        "qData": {},
        "qShowSession": true
      }
    },
    "qPropForThis": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qExtendsId": "value",
      "qMetaDef": {},
      "qStateName": "value",
      "qAppObjectListDef": {
        "qType": "value",
        "qData": {}
      },
      "qBookmarkListDef": {
        "qType": "value",
        "qData": {},
        "qIncludePatches": true
      },
      "qChildListDef": {
        "qData": {}
      },
      "qDimensionListDef": {
        "qType": "value",
        "qData": {}
      },
      "qEmbeddedSnapshotDef": {},
      "qExtensionListDef": {},
      "qFieldListDef": {
        "qShowSystem": false,
        "qShowHidden": false,
        "qShowSemantic": false,
        "qShowSrcTables": false,
        "qShowDefinitionOnly": false,
        "qShowDerivedFields": false,
        "qShowImplicit": false
      },
      "qHyperCubeDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qNullSuppression": true,
            "qIncludeElemValue": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowTotal": true,
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCond": {
              "qv": "value"
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            }
          }
        ],
        "qMeasures": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qReductionMode": "N",
        "qMode": "S",
        "qPseudoDimPos": -1,
        "qNoOfLeftDims": -1,
        "qAlwaysFullyExpanded": false,
        "qMaxStackedCells": 5000,
        "qPopulateMissing": false,
        "qShowTotalsAbove": false,
        "qIndentMode": false,
        "qCalcCond": {
          "qv": "value"
        },
        "qSortbyYValue": 0,
        "qTitle": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qColumnOrder": [
          123
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qDynamicScript": [
          "value"
        ],
        "qContextSetExpression": "value",
        "qSuppressMeasureTotals": true
      },
      "qLayoutExclude": {},
      "qListObjectDef": {
        "qStateName": "value",
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qAutoSortByState": {
          "qDisplayNumberOfRows": 123
        },
        "qFrequencyMode": "N",
        "qShowAlternatives": true,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qExpressions": [
          {
            "qExpr": "value",
            "qLibraryId": "value"
          }
        ],
        "qDirectQuerySimplifiedView": true
      },
      "qMeasureListDef": {
        "qType": "value",
        "qData": {}
      },
      "qMediaListDef": {},
      "qNxLibraryDimensionDef": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value",
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qNxLibraryMeasureDef": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qSelectionObjectDef": {
        "qStateName": "value"
      },
      "qStaticContentUrlDef": {
        "qUrl": "value"
      },
      "qStringExpression": {
        "qExpr": "value"
      },
      "qTreeDataDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qValueExprs": [
              {
                "qLibraryId": "value",
                "qDef": {
                  "qLabel": "value",
                  "qDescription": "value",
                  "qTags": [
                    "value"
                  ],
                  "qGrouping": "N",
                  "qDef": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qRelative": true,
                  "qBrutalSum": true,
                  "qAggrFunc": "value",
                  "qAccumulate": 123,
                  "qReverseSort": true,
                  "qActiveExpression": 123,
                  "qExpressions": [
                    "value"
                  ],
                  "qLabelExpression": "value"
                },
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qAttributeDimensions": [
                  {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qAttribute": true
                  }
                ],
                "qCalcCond": {
                  "qv": "value"
                },
                "qCalcCondition": {
                  "qCond": {
                    "qv": "value"
                  },
                  "qMsg": {
                    "qv": "value"
                  }
                },
                "qTrendLines": [
                  {
                    "qType": "AVERAGE",
                    "qXColIx": -1,
                    "qCalcR2": false,
                    "qContinuousXAxis": "Never",
                    "qMultiDimMode": "Multi"
                  }
                ],
                "qMiniChartDef": {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qOtherTotalSpec": {
                    "qOtherMode": "OTHER_OFF",
                    "qOtherCounted": {
                      "qv": "value"
                    },
                    "qOtherLimit": {
                      "qv": "value"
                    },
                    "qOtherLimitMode": "OTHER_GE_LIMIT",
                    "qSuppressOther": false,
                    "qForceBadValueKeeping": true,
                    "qApplyEvenWhenPossiblyWrongResult": true,
                    "qGlobalOtherGrouping": false,
                    "qOtherCollapseInnerDimensions": false,
                    "qOtherSortMode": "OTHER_SORT_DEFAULT",
                    "qTotalMode": "TOTAL_OFF",
                    "qReferencedExpression": {
                      "qv": "value"
                    }
                  },
                  "qMaxNumberPoints": -1,
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qNullSuppression": true
                }
              }
            ],
            "qNullSuppression": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ]
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qOpenFullyExpanded": false,
        "qPopulateMissing": false,
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTitle": {
          "qv": "value"
        },
        "qInitialDataFetch": [
          {
            "qMaxNbrOfNodes": 123,
            "qTreeNodes": [
              {
                "qArea": {
                  "qLeft": 123,
                  "qTop": 123,
                  "qWidth": 123,
                  "qHeight": 123
                },
                "qAllValues": true
              }
            ],
            "qTreeLevels": {
              "qLeft": 123,
              "qDepth": -1
            }
          }
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qContextSetExpression": "value"
      },
      "qUndoInfoDef": {},
      "qValueExpression": {
        "qExpr": "value"
      },
      "qVariableListDef": {
        "qType": "value",
        "qShowReserved": true,
        "qShowConfig": true,
        "qData": {},
        "qShowSession": true
      }
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qInfo": {
      "qId": "value",
      "qType": "value"
    },
    "qReturn": {
      "qType": "value",
      "qHandle": 123,
      "qGenericType": "value",
      "qGenericId": "value"
    }
  }
}

GenericObject CreateGroup

(qPath, qGroupDef, qTargetGroupId?)
Experimental

You can use the CreateGroup method with any object that contains an object grouping definition. This method allows you to create a new subgroup of objects directly and add it to a group's members. Returns the ID of the created subgroup.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example /qNxGroupDef .

  • qGroupDef object
    Required Experimental

    Definition of the new group.

    Show qGroupDef properties
    • qClass string

      Can be one of: "bookmark""object"

    • qObjectType string

      Specifies the type of the group's object members.

      default = "bookmark"

    • qGroupType string

      Specifies the type of the group's subgroup members.

      default = "objectgroup"

    • qLabel string

      The group's label. Will be evaluated as an expression if it starts with '='.

    • qIncludeOrphanGroups boolean

      Include all groups of the relevant type, by adding those groups last that are not explicitly included in the hierarchy (orphans)

    • qMemberIds array of objects
      Experimental

      The objects and sub-groups that are members of the group.

      Show qMemberIds properties
      • qGroupId string
      • qObjectId string
  • qTargetGroupId string

    Id of the group to create the new subgroup in (if not the called object).

Response

  • qGroupId string

Errors

array
GenericErrors

CreateGroup(qPath, qGroupDef, qTargetGroupId?)

enigma.js
const result = await genericObject.createGroup("value", {
  "qClass": "bookmark",
  "qObjectType": "bookmark",
  "qGroupType": "objectgroup",
  "qLabel": "value",
  "qIncludeOrphanGroups": true,
  "qMemberIds": [
    {
      "qGroupId": "value",
      "qObjectId": "value"
    }
  ]
}, "value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "CreateGroup",
  "params": {
    "qPath": "value",
    "qGroupDef": {
      "qClass": "bookmark",
      "qObjectType": "bookmark",
      "qGroupType": "objectgroup",
      "qLabel": "value",
      "qIncludeOrphanGroups": true,
      "qMemberIds": [
        {
          "qGroupId": "value",
          "qObjectId": "value"
        }
      ]
    },
    "qTargetGroupId": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qGroupId": "value"
  }
}

GenericObject DestroyAllChildren

(qPropForThis?)

Removes all children and all children to the children on an object.

Parameters

  • qPropForThis object

    Identifier of the parent's object and property to update. Should be set to update the properties of the parent's object at the same time the child is created.

    Show qPropForThis properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qExtendsId string

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDef object

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qType string

        Type of the app list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDef object

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qIncludePatches boolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDef object

      Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

      Show qChildListDef properties
      • qData object

        Contains dynamic JSON data specified by the client.
    • qDimensionListDef object

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDef object

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDef object

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDef object

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystem boolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHidden boolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemantic boolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTables boolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnly boolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFields boolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicit boolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDef object

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qIncludeElemValue boolean
        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowTotal boolean
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
      • qMeasures array of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qInterColumnSortOrder array of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qInitialDataFetch array of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionMode string

        Can be one of: "N""D1""S""C""ST"

      • qMode string

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPos integer

        default = -1, format = int32, default = -1

      • qNoOfLeftDims integer

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpanded boolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCells integer

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAbove boolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentMode boolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qSortbyYValue integer

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qColumnOrder array of integers

        The order of the columns.

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qDynamicScript array of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.

      • qSuppressMeasureTotals boolean

        When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
    • qLayoutExclude object

      Contains JSON to be excluded from validation.

    • qListObjectDef object

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveField integer

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

          Alias of the dimension.
      • qAutoSortByState object
        Show qAutoSortByState properties
        • qDisplayNumberOfRows integer

          This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyMode string

        Can be one of: "N""V""P""R"

      • qShowAlternatives boolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetch array of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressions array of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qLibraryId string

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedView boolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDef object

      Defines the list of measures.

      Show qMeasureListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qMediaListDef object

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDef object
      Show qNxLibraryDimensionDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDef object
      Show qNxLibraryMeasureDef properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

        Can be one of: "N""H""C"

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDef object

      To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

      Properties

      "qSelectionObjectDef": {}

      Show qSelectionObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDef object
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrl string

        Relative path of the thumbnail.
    • qStringExpression object

      Properties

      Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string
      The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      A string expression is not evaluated, if the expression is surrounded by simple quotes.
      The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
      Show qStringExpression properties
      • qExpr string
    • qTreeDataDef object

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qValueExprs array of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrder array of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qOpenFullyExpanded boolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qInitialDataFetch array of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodes integer

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodes array of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qArea object
            Show qArea properties
            • qLeft integer

              Position from the left. Corresponds to the first column.

              format = int32

            • qTop integer

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidth integer

              Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

            • qHeight integer

              Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

          • qAllValues boolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevels object
          Show qTreeLevels properties
          • qLeft integer

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepth integer

            Number of dimensions to include in the tree.

            default = -1, format = int32, default = -1

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension.

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qValueExprs array of objects

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.
    • qUndoInfoDef object

      Defines if an object should contain information on the number of possible undo and redo.

      Properties

      "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

    • qValueExpression object

      Properties

      Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string.
      The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      The expression is evaluated as a numeric.
      Show qValueExpression properties
      • qExpr string
    • qVariableListDef object

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qType string

        Type of variables to include in the list.

      • qShowReserved boolean

        Shows the reserved variables if set to true.

      • qShowConfig boolean

        Shows the system variables if set to true.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qShowSession boolean

        Shows the session variables if set to true.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object

Response

object

Errors

array
GenericErrors

DestroyAllChildren(qPropForThis?)

enigma.js
const result = await genericObject.destroyAllChildren({
  "qInfo": {
    "qId": "value",
    "qType": "value"
  },
  "qExtendsId": "value",
  "qMetaDef": {},
  "qStateName": "value",
  "qAppObjectListDef": {
    "qType": "value",
    "qData": {}
  },
  "qBookmarkListDef": {
    "qType": "value",
    "qData": {},
    "qIncludePatches": true
  },
  "qChildListDef": {
    "qData": {}
  },
  "qDimensionListDef": {
    "qType": "value",
    "qData": {}
  },
  "qEmbeddedSnapshotDef": {},
  "qExtensionListDef": {},
  "qFieldListDef": {
    "qShowSystem": false,
    "qShowHidden": false,
    "qShowSemantic": false,
    "qShowSrcTables": false,
    "qShowDefinitionOnly": false,
    "qShowDerivedFields": false,
    "qShowImplicit": false
  },
  "qHyperCubeDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qNullSuppression": true,
        "qIncludeElemValue": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowTotal": true,
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCond": {
          "qv": "value"
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        }
      }
    ],
    "qMeasures": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qReductionMode": "N",
    "qMode": "S",
    "qPseudoDimPos": -1,
    "qNoOfLeftDims": -1,
    "qAlwaysFullyExpanded": false,
    "qMaxStackedCells": 5000,
    "qPopulateMissing": false,
    "qShowTotalsAbove": false,
    "qIndentMode": false,
    "qCalcCond": {
      "qv": "value"
    },
    "qSortbyYValue": 0,
    "qTitle": {
      "qv": "value"
    },
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qColumnOrder": [
      123
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qDynamicScript": [
      "value"
    ],
    "qContextSetExpression": "value",
    "qSuppressMeasureTotals": true
  },
  "qLayoutExclude": {},
  "qListObjectDef": {
    "qStateName": "value",
    "qLibraryId": "value",
    "qDef": {
      "qGrouping": "N",
      "qFieldDefs": [
        "value"
      ],
      "qFieldLabels": [
        "value"
      ],
      "qSortCriterias": [
        {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        }
      ],
      "qNumberPresentations": [
        {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        }
      ],
      "qReverseSort": true,
      "qActiveField": 123,
      "qLabelExpression": "value",
      "qAlias": "value"
    },
    "qAutoSortByState": {
      "qDisplayNumberOfRows": 123
    },
    "qFrequencyMode": "N",
    "qShowAlternatives": true,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qExpressions": [
      {
        "qExpr": "value",
        "qLibraryId": "value"
      }
    ],
    "qDirectQuerySimplifiedView": true
  },
  "qMeasureListDef": {
    "qType": "value",
    "qData": {}
  },
  "qMediaListDef": {},
  "qNxLibraryDimensionDef": {
    "qGrouping": "N",
    "qFieldDefs": [
      "value"
    ],
    "qFieldLabels": [
      "value"
    ],
    "qLabelExpression": "value",
    "qAlias": "value",
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qNxLibraryMeasureDef": {
    "qLabel": "value",
    "qDef": "value",
    "qGrouping": "N",
    "qExpressions": [
      "value"
    ],
    "qActiveExpression": 123,
    "qLabelExpression": "value",
    "qNumFormat": {
      "qType": "U",
      "qnDec": 10,
      "qUseThou": 0,
      "qFmt": "value",
      "qDec": "value",
      "qThou": "value"
    },
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qSelectionObjectDef": {
    "qStateName": "value"
  },
  "qStaticContentUrlDef": {
    "qUrl": "value"
  },
  "qStringExpression": {
    "qExpr": "value"
  },
  "qTreeDataDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qNullSuppression": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ]
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qOpenFullyExpanded": false,
    "qPopulateMissing": false,
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qTitle": {
      "qv": "value"
    },
    "qInitialDataFetch": [
      {
        "qMaxNbrOfNodes": 123,
        "qTreeNodes": [
          {
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            },
            "qAllValues": true
          }
        ],
        "qTreeLevels": {
          "qLeft": 123,
          "qDepth": -1
        }
      }
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qValueExprs": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qContextSetExpression": "value"
  },
  "qUndoInfoDef": {},
  "qValueExpression": {
    "qExpr": "value"
  },
  "qVariableListDef": {
    "qType": "value",
    "qShowReserved": true,
    "qShowConfig": true,
    "qData": {},
    "qShowSession": true
  }
})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "DestroyAllChildren",
  "params": {
    "qPropForThis": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qExtendsId": "value",
      "qMetaDef": {},
      "qStateName": "value",
      "qAppObjectListDef": {
        "qType": "value",
        "qData": {}
      },
      "qBookmarkListDef": {
        "qType": "value",
        "qData": {},
        "qIncludePatches": true
      },
      "qChildListDef": {
        "qData": {}
      },
      "qDimensionListDef": {
        "qType": "value",
        "qData": {}
      },
      "qEmbeddedSnapshotDef": {},
      "qExtensionListDef": {},
      "qFieldListDef": {
        "qShowSystem": false,
        "qShowHidden": false,
        "qShowSemantic": false,
        "qShowSrcTables": false,
        "qShowDefinitionOnly": false,
        "qShowDerivedFields": false,
        "qShowImplicit": false
      },
      "qHyperCubeDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qNullSuppression": true,
            "qIncludeElemValue": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowTotal": true,
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCond": {
              "qv": "value"
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            }
          }
        ],
        "qMeasures": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qReductionMode": "N",
        "qMode": "S",
        "qPseudoDimPos": -1,
        "qNoOfLeftDims": -1,
        "qAlwaysFullyExpanded": false,
        "qMaxStackedCells": 5000,
        "qPopulateMissing": false,
        "qShowTotalsAbove": false,
        "qIndentMode": false,
        "qCalcCond": {
          "qv": "value"
        },
        "qSortbyYValue": 0,
        "qTitle": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qColumnOrder": [
          123
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qDynamicScript": [
          "value"
        ],
        "qContextSetExpression": "value",
        "qSuppressMeasureTotals": true
      },
      "qLayoutExclude": {},
      "qListObjectDef": {
        "qStateName": "value",
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qAutoSortByState": {
          "qDisplayNumberOfRows": 123
        },
        "qFrequencyMode": "N",
        "qShowAlternatives": true,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qExpressions": [
          {
            "qExpr": "value",
            "qLibraryId": "value"
          }
        ],
        "qDirectQuerySimplifiedView": true
      },
      "qMeasureListDef": {
        "qType": "value",
        "qData": {}
      },
      "qMediaListDef": {},
      "qNxLibraryDimensionDef": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value",
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qNxLibraryMeasureDef": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qSelectionObjectDef": {
        "qStateName": "value"
      },
      "qStaticContentUrlDef": {
        "qUrl": "value"
      },
      "qStringExpression": {
        "qExpr": "value"
      },
      "qTreeDataDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qValueExprs": [
              {
                "qLibraryId": "value",
                "qDef": {
                  "qLabel": "value",
                  "qDescription": "value",
                  "qTags": [
                    "value"
                  ],
                  "qGrouping": "N",
                  "qDef": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qRelative": true,
                  "qBrutalSum": true,
                  "qAggrFunc": "value",
                  "qAccumulate": 123,
                  "qReverseSort": true,
                  "qActiveExpression": 123,
                  "qExpressions": [
                    "value"
                  ],
                  "qLabelExpression": "value"
                },
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qAttributeDimensions": [
                  {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qAttribute": true
                  }
                ],
                "qCalcCond": {
                  "qv": "value"
                },
                "qCalcCondition": {
                  "qCond": {
                    "qv": "value"
                  },
                  "qMsg": {
                    "qv": "value"
                  }
                },
                "qTrendLines": [
                  {
                    "qType": "AVERAGE",
                    "qXColIx": -1,
                    "qCalcR2": false,
                    "qContinuousXAxis": "Never",
                    "qMultiDimMode": "Multi"
                  }
                ],
                "qMiniChartDef": {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qOtherTotalSpec": {
                    "qOtherMode": "OTHER_OFF",
                    "qOtherCounted": {
                      "qv": "value"
                    },
                    "qOtherLimit": {
                      "qv": "value"
                    },
                    "qOtherLimitMode": "OTHER_GE_LIMIT",
                    "qSuppressOther": false,
                    "qForceBadValueKeeping": true,
                    "qApplyEvenWhenPossiblyWrongResult": true,
                    "qGlobalOtherGrouping": false,
                    "qOtherCollapseInnerDimensions": false,
                    "qOtherSortMode": "OTHER_SORT_DEFAULT",
                    "qTotalMode": "TOTAL_OFF",
                    "qReferencedExpression": {
                      "qv": "value"
                    }
                  },
                  "qMaxNumberPoints": -1,
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qNullSuppression": true
                }
              }
            ],
            "qNullSuppression": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ]
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qOpenFullyExpanded": false,
        "qPopulateMissing": false,
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTitle": {
          "qv": "value"
        },
        "qInitialDataFetch": [
          {
            "qMaxNbrOfNodes": 123,
            "qTreeNodes": [
              {
                "qArea": {
                  "qLeft": 123,
                  "qTop": 123,
                  "qWidth": 123,
                  "qHeight": 123
                },
                "qAllValues": true
              }
            ],
            "qTreeLevels": {
              "qLeft": 123,
              "qDepth": -1
            }
          }
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qContextSetExpression": "value"
      },
      "qUndoInfoDef": {},
      "qValueExpression": {
        "qExpr": "value"
      },
      "qVariableListDef": {
        "qType": "value",
        "qShowReserved": true,
        "qShowConfig": true,
        "qData": {},
        "qShowSession": true
      }
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject DestroyChild

(qId, qPropForThis?)

Removes a child object.

It is possible to update the properties of the child's parent at the same time that the child is removed. Both operations are performed by the same call.
Removing a linked object, invalidate the linking object.
The operation is successful if **qSuccess** is set to true.

Parameters

  • qId string
    Required

    Identifier of the child to remove.

  • qPropForThis object

    Identifier of the parent's object and property to update. Should be set to update the properties of the parent's object at the same time the child is created.

    Show qPropForThis properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qExtendsId string

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDef object

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qType string

        Type of the app list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDef object

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qIncludePatches boolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDef object

      Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

      Show qChildListDef properties
      • qData object

        Contains dynamic JSON data specified by the client.
    • qDimensionListDef object

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDef object

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDef object

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDef object

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystem boolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHidden boolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemantic boolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTables boolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnly boolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFields boolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicit boolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDef object

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qIncludeElemValue boolean
        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowTotal boolean
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
      • qMeasures array of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qInterColumnSortOrder array of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qInitialDataFetch array of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionMode string

        Can be one of: "N""D1""S""C""ST"

      • qMode string

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPos integer

        default = -1, format = int32, default = -1

      • qNoOfLeftDims integer

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpanded boolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCells integer

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAbove boolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentMode boolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qSortbyYValue integer

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qColumnOrder array of integers

        The order of the columns.

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qDynamicScript array of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.

      • qSuppressMeasureTotals boolean

        When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
    • qLayoutExclude object

      Contains JSON to be excluded from validation.

    • qListObjectDef object

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveField integer

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

          Alias of the dimension.
      • qAutoSortByState object
        Show qAutoSortByState properties
        • qDisplayNumberOfRows integer

          This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyMode string

        Can be one of: "N""V""P""R"

      • qShowAlternatives boolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetch array of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressions array of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qLibraryId string

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedView boolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDef object

      Defines the list of measures.

      Show qMeasureListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qMediaListDef object

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDef object
      Show qNxLibraryDimensionDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDef object
      Show qNxLibraryMeasureDef properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

        Can be one of: "N""H""C"

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDef object

      To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

      Properties

      "qSelectionObjectDef": {}

      Show qSelectionObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDef object
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrl string

        Relative path of the thumbnail.
    • qStringExpression object

      Properties

      Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string
      The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      A string expression is not evaluated, if the expression is surrounded by simple quotes.
      The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
      Show qStringExpression properties
      • qExpr string
    • qTreeDataDef object

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qValueExprs array of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrder array of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qOpenFullyExpanded boolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qInitialDataFetch array of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodes integer

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodes array of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qArea object
            Show qArea properties
            • qLeft integer

              Position from the left. Corresponds to the first column.

              format = int32

            • qTop integer

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidth integer

              Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

            • qHeight integer

              Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

          • qAllValues boolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevels object
          Show qTreeLevels properties
          • qLeft integer

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepth integer

            Number of dimensions to include in the tree.

            default = -1, format = int32, default = -1

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension.

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qValueExprs array of objects

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.
    • qUndoInfoDef object

      Defines if an object should contain information on the number of possible undo and redo.

      Properties

      "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

    • qValueExpression object

      Properties

      Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string.
      The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      The expression is evaluated as a numeric.
      Show qValueExpression properties
      • qExpr string
    • qVariableListDef object

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qType string

        Type of variables to include in the list.

      • qShowReserved boolean

        Shows the reserved variables if set to true.

      • qShowConfig boolean

        Shows the system variables if set to true.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qShowSession boolean

        Shows the session variables if set to true.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object

Response

  • qSuccess boolean

Errors

array
GenericErrors

DestroyChild(qId, qPropForThis?)

enigma.js
const result = await genericObject.destroyChild("value", {
  "qInfo": {
    "qId": "value",
    "qType": "value"
  },
  "qExtendsId": "value",
  "qMetaDef": {},
  "qStateName": "value",
  "qAppObjectListDef": {
    "qType": "value",
    "qData": {}
  },
  "qBookmarkListDef": {
    "qType": "value",
    "qData": {},
    "qIncludePatches": true
  },
  "qChildListDef": {
    "qData": {}
  },
  "qDimensionListDef": {
    "qType": "value",
    "qData": {}
  },
  "qEmbeddedSnapshotDef": {},
  "qExtensionListDef": {},
  "qFieldListDef": {
    "qShowSystem": false,
    "qShowHidden": false,
    "qShowSemantic": false,
    "qShowSrcTables": false,
    "qShowDefinitionOnly": false,
    "qShowDerivedFields": false,
    "qShowImplicit": false
  },
  "qHyperCubeDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qNullSuppression": true,
        "qIncludeElemValue": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowTotal": true,
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCond": {
          "qv": "value"
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        }
      }
    ],
    "qMeasures": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qReductionMode": "N",
    "qMode": "S",
    "qPseudoDimPos": -1,
    "qNoOfLeftDims": -1,
    "qAlwaysFullyExpanded": false,
    "qMaxStackedCells": 5000,
    "qPopulateMissing": false,
    "qShowTotalsAbove": false,
    "qIndentMode": false,
    "qCalcCond": {
      "qv": "value"
    },
    "qSortbyYValue": 0,
    "qTitle": {
      "qv": "value"
    },
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qColumnOrder": [
      123
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qDynamicScript": [
      "value"
    ],
    "qContextSetExpression": "value",
    "qSuppressMeasureTotals": true
  },
  "qLayoutExclude": {},
  "qListObjectDef": {
    "qStateName": "value",
    "qLibraryId": "value",
    "qDef": {
      "qGrouping": "N",
      "qFieldDefs": [
        "value"
      ],
      "qFieldLabels": [
        "value"
      ],
      "qSortCriterias": [
        {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        }
      ],
      "qNumberPresentations": [
        {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        }
      ],
      "qReverseSort": true,
      "qActiveField": 123,
      "qLabelExpression": "value",
      "qAlias": "value"
    },
    "qAutoSortByState": {
      "qDisplayNumberOfRows": 123
    },
    "qFrequencyMode": "N",
    "qShowAlternatives": true,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qExpressions": [
      {
        "qExpr": "value",
        "qLibraryId": "value"
      }
    ],
    "qDirectQuerySimplifiedView": true
  },
  "qMeasureListDef": {
    "qType": "value",
    "qData": {}
  },
  "qMediaListDef": {},
  "qNxLibraryDimensionDef": {
    "qGrouping": "N",
    "qFieldDefs": [
      "value"
    ],
    "qFieldLabels": [
      "value"
    ],
    "qLabelExpression": "value",
    "qAlias": "value",
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qNxLibraryMeasureDef": {
    "qLabel": "value",
    "qDef": "value",
    "qGrouping": "N",
    "qExpressions": [
      "value"
    ],
    "qActiveExpression": 123,
    "qLabelExpression": "value",
    "qNumFormat": {
      "qType": "U",
      "qnDec": 10,
      "qUseThou": 0,
      "qFmt": "value",
      "qDec": "value",
      "qThou": "value"
    },
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qSelectionObjectDef": {
    "qStateName": "value"
  },
  "qStaticContentUrlDef": {
    "qUrl": "value"
  },
  "qStringExpression": {
    "qExpr": "value"
  },
  "qTreeDataDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qNullSuppression": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ]
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qOpenFullyExpanded": false,
    "qPopulateMissing": false,
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qTitle": {
      "qv": "value"
    },
    "qInitialDataFetch": [
      {
        "qMaxNbrOfNodes": 123,
        "qTreeNodes": [
          {
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            },
            "qAllValues": true
          }
        ],
        "qTreeLevels": {
          "qLeft": 123,
          "qDepth": -1
        }
      }
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qValueExprs": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qContextSetExpression": "value"
  },
  "qUndoInfoDef": {},
  "qValueExpression": {
    "qExpr": "value"
  },
  "qVariableListDef": {
    "qType": "value",
    "qShowReserved": true,
    "qShowConfig": true,
    "qData": {},
    "qShowSession": true
  }
})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "DestroyChild",
  "params": {
    "qId": "value",
    "qPropForThis": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qExtendsId": "value",
      "qMetaDef": {},
      "qStateName": "value",
      "qAppObjectListDef": {
        "qType": "value",
        "qData": {}
      },
      "qBookmarkListDef": {
        "qType": "value",
        "qData": {},
        "qIncludePatches": true
      },
      "qChildListDef": {
        "qData": {}
      },
      "qDimensionListDef": {
        "qType": "value",
        "qData": {}
      },
      "qEmbeddedSnapshotDef": {},
      "qExtensionListDef": {},
      "qFieldListDef": {
        "qShowSystem": false,
        "qShowHidden": false,
        "qShowSemantic": false,
        "qShowSrcTables": false,
        "qShowDefinitionOnly": false,
        "qShowDerivedFields": false,
        "qShowImplicit": false
      },
      "qHyperCubeDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qNullSuppression": true,
            "qIncludeElemValue": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowTotal": true,
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCond": {
              "qv": "value"
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            }
          }
        ],
        "qMeasures": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qReductionMode": "N",
        "qMode": "S",
        "qPseudoDimPos": -1,
        "qNoOfLeftDims": -1,
        "qAlwaysFullyExpanded": false,
        "qMaxStackedCells": 5000,
        "qPopulateMissing": false,
        "qShowTotalsAbove": false,
        "qIndentMode": false,
        "qCalcCond": {
          "qv": "value"
        },
        "qSortbyYValue": 0,
        "qTitle": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qColumnOrder": [
          123
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qDynamicScript": [
          "value"
        ],
        "qContextSetExpression": "value",
        "qSuppressMeasureTotals": true
      },
      "qLayoutExclude": {},
      "qListObjectDef": {
        "qStateName": "value",
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qAutoSortByState": {
          "qDisplayNumberOfRows": 123
        },
        "qFrequencyMode": "N",
        "qShowAlternatives": true,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qExpressions": [
          {
            "qExpr": "value",
            "qLibraryId": "value"
          }
        ],
        "qDirectQuerySimplifiedView": true
      },
      "qMeasureListDef": {
        "qType": "value",
        "qData": {}
      },
      "qMediaListDef": {},
      "qNxLibraryDimensionDef": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value",
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qNxLibraryMeasureDef": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qSelectionObjectDef": {
        "qStateName": "value"
      },
      "qStaticContentUrlDef": {
        "qUrl": "value"
      },
      "qStringExpression": {
        "qExpr": "value"
      },
      "qTreeDataDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qValueExprs": [
              {
                "qLibraryId": "value",
                "qDef": {
                  "qLabel": "value",
                  "qDescription": "value",
                  "qTags": [
                    "value"
                  ],
                  "qGrouping": "N",
                  "qDef": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qRelative": true,
                  "qBrutalSum": true,
                  "qAggrFunc": "value",
                  "qAccumulate": 123,
                  "qReverseSort": true,
                  "qActiveExpression": 123,
                  "qExpressions": [
                    "value"
                  ],
                  "qLabelExpression": "value"
                },
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qAttributeDimensions": [
                  {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qAttribute": true
                  }
                ],
                "qCalcCond": {
                  "qv": "value"
                },
                "qCalcCondition": {
                  "qCond": {
                    "qv": "value"
                  },
                  "qMsg": {
                    "qv": "value"
                  }
                },
                "qTrendLines": [
                  {
                    "qType": "AVERAGE",
                    "qXColIx": -1,
                    "qCalcR2": false,
                    "qContinuousXAxis": "Never",
                    "qMultiDimMode": "Multi"
                  }
                ],
                "qMiniChartDef": {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qOtherTotalSpec": {
                    "qOtherMode": "OTHER_OFF",
                    "qOtherCounted": {
                      "qv": "value"
                    },
                    "qOtherLimit": {
                      "qv": "value"
                    },
                    "qOtherLimitMode": "OTHER_GE_LIMIT",
                    "qSuppressOther": false,
                    "qForceBadValueKeeping": true,
                    "qApplyEvenWhenPossiblyWrongResult": true,
                    "qGlobalOtherGrouping": false,
                    "qOtherCollapseInnerDimensions": false,
                    "qOtherSortMode": "OTHER_SORT_DEFAULT",
                    "qTotalMode": "TOTAL_OFF",
                    "qReferencedExpression": {
                      "qv": "value"
                    }
                  },
                  "qMaxNumberPoints": -1,
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qNullSuppression": true
                }
              }
            ],
            "qNullSuppression": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ]
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qOpenFullyExpanded": false,
        "qPopulateMissing": false,
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTitle": {
          "qv": "value"
        },
        "qInitialDataFetch": [
          {
            "qMaxNbrOfNodes": 123,
            "qTreeNodes": [
              {
                "qArea": {
                  "qLeft": 123,
                  "qTop": 123,
                  "qWidth": 123,
                  "qHeight": 123
                },
                "qAllValues": true
              }
            ],
            "qTreeLevels": {
              "qLeft": 123,
              "qDepth": -1
            }
          }
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qContextSetExpression": "value"
      },
      "qUndoInfoDef": {},
      "qValueExpression": {
        "qExpr": "value"
      },
      "qVariableListDef": {
        "qType": "value",
        "qShowReserved": true,
        "qShowConfig": true,
        "qData": {},
        "qShowSession": true
      }
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject DrillUp

(qPath, qDimNo, qNbrSteps)

You can use the drillUp method with any object that contains a drill-down group as a dimension. This method allows you to move between different levels of information (from a detailed level to a less detailed level of information). You can go back to previous visualizations up to the highest level of the hierarchy. If you try to drill up more steps than there are available levels, the first level of the hierarchy is displayed.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qDimNo integer
    Required

    Dimension number or index starting from 0. The default value is 0.

  • qNbrSteps integer
    Required

    Number of steps you want to drill up. The default value is 0.

Response

object

Errors

array
GenericErrors

DrillUp(qPath, qDimNo, qNbrSteps)

enigma.js
const result = await genericObject.drillUp("value", 123, 123)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "DrillUp",
  "params": {
    "qPath": "value",
    "qDimNo": 123,
    "qNbrSteps": 123
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject EmbedSnapshotObject

(qId)

Adds a snapshot to a generic object.

Only one snapshot can be embedded in a generic object.
If you embed a snapshot in an object that already contains a snapshot, the new snapshot overwrites the previous one.

Parameters

  • qId string
    Required

    Identifier of the bookmark.

Response

object

Errors

array
GenericErrors

EmbedSnapshotObject(qId)

enigma.js
const result = await genericObject.embedSnapshotObject("value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "EmbedSnapshotObject",
  "params": {
    "qId": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject EndSelections

(qAccept)

Ends the selection mode on a visualization. The selections are accepted or aborted when exiting the selection mode, depending on the qAccept parameter value.

Parameters

  • qAccept boolean
    Required

    Set this parameter to true to accept the selections before exiting the selection mode.

Response

object

Errors

array
GenericErrors

EndSelections(qAccept)

enigma.js
const result = await genericObject.endSelections(true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "EndSelections",
  "params": {
    "qAccept": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject ExpandLeft

(qPath, qRow, qCol, qAll)

Expands the left dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded. In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be expanded. For example, /qHyperCubeDef .

  • qRow integer
    Required

    Row index in the data matrix to expand. Indexing starts from 0.

  • qCol integer
    Required

    Column index. The index is based on the left dimension indexes. Indexing starts from 0.

  • qAll boolean
    Required

    If set to true, it expands all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

Response

object

Errors

array
GenericErrors

ExpandLeft(qPath, qRow, qCol, qAll)

enigma.js
const result = await genericObject.expandLeft("value", 123, 123, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ExpandLeft",
  "params": {
    "qPath": "value",
    "qRow": 123,
    "qCol": 123,
    "qAll": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject ExpandTop

(qPath, qRow, qCol, qAll)

Expands the top dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded. In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be expanded. For example, /qHyperCubeDef .

  • qRow integer
    Required

    Row index. The index is based on the top dimension indexes. Indexing starts from 0.

  • qCol integer
    Required

    Column index in the data matrix. Indexing starts from 0.

  • qAll boolean
    Required

    If set to true, it expands all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

Response

object

Errors

array
GenericErrors

ExpandTop(qPath, qRow, qCol, qAll)

enigma.js
const result = await genericObject.expandTop("value", 123, 123, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ExpandTop",
  "params": {
    "qPath": "value",
    "qRow": 123,
    "qCol": 123,
    "qAll": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject ExportData

(qFileType, qPath?, qFileName?, qExportState?, qServeOnce?)

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported. This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

ExportData method is not supported in SaaS Editions of Qlik Sense.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

  • 1,048,576 rows per sheet. For pivot tables: 1,048,576 column dimensions. 10 rows can be added after the export.
  • 16,384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitation in number of columns

The default maximum number of columns in the export file is:

  • 1,000 for CSV file export.

Default limitation in number of cells

The default maximum number of cells in the export file is:

  • 5,000,000 for CSV file export.

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

There is an option to export only the possible values ( _qExportState_ is P).

Default limitation in size

If the exported file is larger than the maximum value, an Out of Memory (OOM) error with code 13000 is returned.

Exported files are temporary and are available only for a certain time span and only to the user who created them.

Parameters

  • qFileType string
    Required

    Type of the file to export.

    One of:

    • CSV_C or EXPORT_CSV_C
    • CSV_T or EXPORT_CSV_T
    • OOXML or EXPORT_OOXML
    • PARQUET or EXPORT_PARQUET
  • qPath string

    Path to the definition of the object to be exported. For example, /qHyperCubeDef . This parameter is mandatory if the file type is CSV_C or CSV_T .

  • qFileName string

    Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop.

  • qExportState string

    Defines the values to be exported. The default value is A.

    One of:

    • P or EXPORT_POSSIBLE
    • A or EXPORT_ALL
  • qServeOnce boolean

    If the exported file should be served only once This parameter is optional and only used in Qlik Sense Enterprise (Windows) Default value: false

Response

  • qUrl string
  • qWarnings array of integers

Errors

array
GenericErrors

ExportData(qFileType, qPath?, qFileName?, qExportState?, qServeOnce?)

enigma.js
const result = await genericObject.exportData("value", "value", "value", "value", true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ExportData",
  "params": {
    "qFileType": "value",
    "qPath": "value",
    "qFileName": "value",
    "qExportState": "value",
    "qServeOnce": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qUrl": "value",
    "qWarnings": [
      123
    ]
  }
}

GenericObject GetChild

(qId)

Returns the type of the object and the corresponding handle.

Parameters

  • qId string
    Required

    Identifier of the object.

Response

  • qReturn object
    Show qReturn properties
    • qType string

      The native type of the object.

    • qHandle integer

      The handle used to connect to object.

      format = int32

    • qGenericType string

      The type of the object.

    • qGenericId string

      Object ID.

Errors

array
GenericErrors

GetChild(qId)

enigma.js
const result = await genericObject.getChild("value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetChild",
  "params": {
    "qId": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qReturn": {
      "qType": "value",
      "qHandle": 123,
      "qGenericType": "value",
      "qGenericId": "value"
    }
  }
}

GenericObject GetChildInfos

()

Returns the identifier and the type for each child in an app object. If the child contains extra properties in qInfos , these properties are returned.

Full dynamic properties are optional and are returned if they exist in the definition of the object.

Response

  • qInfos array of objects
    Show qInfos properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.

Errors

array
GenericErrors

GetChildInfos()

enigma.js
const result = await genericObject.getChildInfos()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetChildInfos"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qInfos": [
      {
        "qId": "value",
        "qType": "value"
      }
    ]
  }
}

GenericObject GetEffectiveProperties

()

Returns the identifier, the type and the properties of the object. If the object contains some soft properties, the soft properties are returned. If the object is linked to another object, the properties of the linking object are returned.

Response

  • qProp object
    Show qProp properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qExtendsId string

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDef object

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qType string

        Type of the app list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDef object

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qIncludePatches boolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDef object

      Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

      Show qChildListDef properties
      • qData object

        Contains dynamic JSON data specified by the client.
    • qDimensionListDef object

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDef object

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDef object

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDef object

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystem boolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHidden boolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemantic boolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTables boolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnly boolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFields boolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicit boolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDef object

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qIncludeElemValue boolean
        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowTotal boolean
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
      • qMeasures array of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qInterColumnSortOrder array of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qInitialDataFetch array of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionMode string

        Can be one of: "N""D1""S""C""ST"

      • qMode string

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPos integer

        default = -1, format = int32, default = -1

      • qNoOfLeftDims integer

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpanded boolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCells integer

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAbove boolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentMode boolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qSortbyYValue integer

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qColumnOrder array of integers

        The order of the columns.

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qDynamicScript array of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.

      • qSuppressMeasureTotals boolean

        When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
    • qLayoutExclude object

      Contains JSON to be excluded from validation.

    • qListObjectDef object

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveField integer

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

          Alias of the dimension.
      • qAutoSortByState object
        Show qAutoSortByState properties
        • qDisplayNumberOfRows integer

          This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyMode string

        Can be one of: "N""V""P""R"

      • qShowAlternatives boolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetch array of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressions array of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qLibraryId string

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedView boolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDef object

      Defines the list of measures.

      Show qMeasureListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qMediaListDef object

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDef object
      Show qNxLibraryDimensionDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDef object
      Show qNxLibraryMeasureDef properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

        Can be one of: "N""H""C"

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDef object

      To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

      Properties

      "qSelectionObjectDef": {}

      Show qSelectionObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDef object
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrl string

        Relative path of the thumbnail.
    • qStringExpression object

      Properties

      Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string
      The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      A string expression is not evaluated, if the expression is surrounded by simple quotes.
      The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
      Show qStringExpression properties
      • qExpr string
    • qTreeDataDef object

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qValueExprs array of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrder array of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qOpenFullyExpanded boolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qInitialDataFetch array of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodes integer

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodes array of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qArea object
            Show qArea properties
            • qLeft integer

              Position from the left. Corresponds to the first column.

              format = int32

            • qTop integer

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidth integer

              Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

            • qHeight integer

              Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

          • qAllValues boolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevels object
          Show qTreeLevels properties
          • qLeft integer

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepth integer

            Number of dimensions to include in the tree.

            default = -1, format = int32, default = -1

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension.

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qValueExprs array of objects

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.
    • qUndoInfoDef object

      Defines if an object should contain information on the number of possible undo and redo.

      Properties

      "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

    • qValueExpression object

      Properties

      Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string.
      The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      The expression is evaluated as a numeric.
      Show qValueExpression properties
      • qExpr string
    • qVariableListDef object

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qType string

        Type of variables to include in the list.

      • qShowReserved boolean

        Shows the reserved variables if set to true.

      • qShowConfig boolean

        Shows the system variables if set to true.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qShowSession boolean

        Shows the session variables if set to true.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object

Errors

array
GenericErrors

GetEffectiveProperties()

enigma.js
const result = await genericObject.getEffectiveProperties()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetEffectiveProperties"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qProp": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qExtendsId": "value",
      "qMetaDef": {},
      "qStateName": "value",
      "qAppObjectListDef": {
        "qType": "value",
        "qData": {}
      },
      "qBookmarkListDef": {
        "qType": "value",
        "qData": {},
        "qIncludePatches": true
      },
      "qChildListDef": {
        "qData": {}
      },
      "qDimensionListDef": {
        "qType": "value",
        "qData": {}
      },
      "qEmbeddedSnapshotDef": {},
      "qExtensionListDef": {},
      "qFieldListDef": {
        "qShowSystem": false,
        "qShowHidden": false,
        "qShowSemantic": false,
        "qShowSrcTables": false,
        "qShowDefinitionOnly": false,
        "qShowDerivedFields": false,
        "qShowImplicit": false
      },
      "qHyperCubeDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qNullSuppression": true,
            "qIncludeElemValue": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowTotal": true,
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCond": {
              "qv": "value"
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            }
          }
        ],
        "qMeasures": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qReductionMode": "N",
        "qMode": "S",
        "qPseudoDimPos": -1,
        "qNoOfLeftDims": -1,
        "qAlwaysFullyExpanded": false,
        "qMaxStackedCells": 5000,
        "qPopulateMissing": false,
        "qShowTotalsAbove": false,
        "qIndentMode": false,
        "qCalcCond": {
          "qv": "value"
        },
        "qSortbyYValue": 0,
        "qTitle": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qColumnOrder": [
          123
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qDynamicScript": [
          "value"
        ],
        "qContextSetExpression": "value",
        "qSuppressMeasureTotals": true
      },
      "qLayoutExclude": {},
      "qListObjectDef": {
        "qStateName": "value",
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qAutoSortByState": {
          "qDisplayNumberOfRows": 123
        },
        "qFrequencyMode": "N",
        "qShowAlternatives": true,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qExpressions": [
          {
            "qExpr": "value",
            "qLibraryId": "value"
          }
        ],
        "qDirectQuerySimplifiedView": true
      },
      "qMeasureListDef": {
        "qType": "value",
        "qData": {}
      },
      "qMediaListDef": {},
      "qNxLibraryDimensionDef": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value",
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qNxLibraryMeasureDef": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qSelectionObjectDef": {
        "qStateName": "value"
      },
      "qStaticContentUrlDef": {
        "qUrl": "value"
      },
      "qStringExpression": {
        "qExpr": "value"
      },
      "qTreeDataDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qValueExprs": [
              {
                "qLibraryId": "value",
                "qDef": {
                  "qLabel": "value",
                  "qDescription": "value",
                  "qTags": [
                    "value"
                  ],
                  "qGrouping": "N",
                  "qDef": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qRelative": true,
                  "qBrutalSum": true,
                  "qAggrFunc": "value",
                  "qAccumulate": 123,
                  "qReverseSort": true,
                  "qActiveExpression": 123,
                  "qExpressions": [
                    "value"
                  ],
                  "qLabelExpression": "value"
                },
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qAttributeDimensions": [
                  {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qAttribute": true
                  }
                ],
                "qCalcCond": {
                  "qv": "value"
                },
                "qCalcCondition": {
                  "qCond": {
                    "qv": "value"
                  },
                  "qMsg": {
                    "qv": "value"
                  }
                },
                "qTrendLines": [
                  {
                    "qType": "AVERAGE",
                    "qXColIx": -1,
                    "qCalcR2": false,
                    "qContinuousXAxis": "Never",
                    "qMultiDimMode": "Multi"
                  }
                ],
                "qMiniChartDef": {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qOtherTotalSpec": {
                    "qOtherMode": "OTHER_OFF",
                    "qOtherCounted": {
                      "qv": "value"
                    },
                    "qOtherLimit": {
                      "qv": "value"
                    },
                    "qOtherLimitMode": "OTHER_GE_LIMIT",
                    "qSuppressOther": false,
                    "qForceBadValueKeeping": true,
                    "qApplyEvenWhenPossiblyWrongResult": true,
                    "qGlobalOtherGrouping": false,
                    "qOtherCollapseInnerDimensions": false,
                    "qOtherSortMode": "OTHER_SORT_DEFAULT",
                    "qTotalMode": "TOTAL_OFF",
                    "qReferencedExpression": {
                      "qv": "value"
                    }
                  },
                  "qMaxNumberPoints": -1,
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qNullSuppression": true
                }
              }
            ],
            "qNullSuppression": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ]
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qOpenFullyExpanded": false,
        "qPopulateMissing": false,
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTitle": {
          "qv": "value"
        },
        "qInitialDataFetch": [
          {
            "qMaxNbrOfNodes": 123,
            "qTreeNodes": [
              {
                "qArea": {
                  "qLeft": 123,
                  "qTop": 123,
                  "qWidth": 123,
                  "qHeight": 123
                },
                "qAllValues": true
              }
            ],
            "qTreeLevels": {
              "qLeft": 123,
              "qDepth": -1
            }
          }
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qContextSetExpression": "value"
      },
      "qUndoInfoDef": {},
      "qValueExpression": {
        "qExpr": "value"
      },
      "qVariableListDef": {
        "qType": "value",
        "qShowReserved": true,
        "qShowConfig": true,
        "qData": {},
        "qShowSession": true
      }
    }
  }
}

GenericObject GetFullPropertyTree

()

Gets the properties of:

  • A generic object.
  • The children of the generic object.
  • The bookmarks/embedded snapshots of the generic object.

Response

  • qPropEntry object
    Show qPropEntry properties
    • qProperty object
      Show qProperty properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qExtendsId string

        Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

      • qMetaDef object

        Used to collect metadata.

        Properties

        Semantic type with an empty structure.

      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qAppObjectListDef object

        Defines the list of objects in an app.

        An app object is a generic object created at app level.
        Show qAppObjectListDef properties
        • qType string

          Type of the app list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qBookmarkListDef object

        Defines the list of bookmarks.

        Show qBookmarkListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.

        • qIncludePatches boolean

          Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
      • qChildListDef object

        Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

        Show qChildListDef properties
        • qData object

          Contains dynamic JSON data specified by the client.
      • qDimensionListDef object

        Defines the lists of dimensions.

        Show qDimensionListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qEmbeddedSnapshotDef object

        Defines the embedded snapshot in a generic object.

        Properties

        "EmbeddedSnapshotDef": {}

      • qExtensionListDef object

        Obsolete, use qrs API's to fetch extensions.

      • qFieldListDef object

        Defines the fields to show.

        Show qFieldListDef properties
        • qShowSystem boolean

          Shows the system tables if set to true. Default is false.

          default = false

        • qShowHidden boolean

          Shows the hidden fields if set to true. Default is false.

          default = false

        • qShowSemantic boolean

          Show the semantic fields if set to true. Default is false.

          default = false

        • qShowSrcTables boolean

          Shows the tables and fields present in the data model viewer if set to true. Default is false.

          default = false

        • qShowDefinitionOnly boolean

          Shows the fields defined on the fly if set to true. Default is false.

          default = false

        • qShowDerivedFields boolean

          Shows the fields and derived fields if set to true. Default is false.

          default = false

        • qShowImplicit boolean

          Shows the Direct Discovery measure fields if set to true. Default is false.

          default = false

      • qHyperCubeDef object

        Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

        Show qHyperCubeDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qDimensions array of objects

          Array of dimensions.

          Show qDimensions properties
          • qLibraryId string

            Refers to a dimension stored in the library.

          • qDef object
            Show qDef properties
            • qGrouping string

              Can be one of: "N""H""C"

            • qFieldDefs array of strings

              Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

            • qFieldLabels array of strings

              Array of field labels. This parameter is optional.

            • qSortCriterias array of objects

              Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

              Show qSortCriterias properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qNumberPresentations array of objects

              Defines the format of the value. This parameter is optional.

              Show qNumberPresentations properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveField integer

              Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

              format = int32

            • qLabelExpression string

              Label expression. This parameter is optional.

            • qAlias string

              Alias of the dimension.
          • qNullSuppression boolean

            If set to true, no null values are returned.

          • qIncludeElemValue boolean
          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qShowTotal boolean
          • qShowAll boolean

            If set to true, all dimension values are shown.

          • qOtherLabel object
            Show qOtherLabel properties
            • qv string

              Expression evaluated to string.
          • qTotalLabel object
            Show qTotalLabel properties
            • qv string

              Expression evaluated to string.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
        • qMeasures array of objects

          Array of measures.

          Show qMeasures properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qInterColumnSortOrder array of integers

          Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

        • qSuppressZero boolean

          Removes zero values.

          default = false

        • qSuppressMissing boolean

          Removes missing values.

          default = false

        • qInitialDataFetch array of objects

          Initial data set.

          Show qInitialDataFetch properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qReductionMode string

          Can be one of: "N""D1""S""C""ST"

        • qMode string

          Can be one of: "S""P""K""T""D"

        • qPseudoDimPos integer

          default = -1, format = int32, default = -1

        • qNoOfLeftDims integer

          Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

          • Four dimensions in the following order: Country, City, Product and Category.
          • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
          • Three left dimensions ( qNoOfLeftDims is set to 3).

          implies that:

          • The index 0 corresponds to the left dimension Country.
          • The index 1 corresponds to the pseudo dimension.
          • The index 2 corresponds to the left dimension City.
          • Product and Category are top dimensions.

          Another example:

          • Four dimensions in the following order: Country, City, Product and Category.
          • Three left dimensions ( qNoOfLeftDims is set to 3).
          • One pseudo dimension.
          • The property qInterColumnSortOrder is left empty.

          Implies that:

          • The index 0 corresponds to the left dimension Country.
          • The index 1 corresponds to the left dimension City.
          • The index 2 corresponds to the left dimension Product.
          • Category is a top dimension.
          • The pseudo dimension is a top dimension.

          default = -1, format = int32, default = -1

        • qAlwaysFullyExpanded boolean

          If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

          default = false

        • qMaxStackedCells integer

          Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

          default = 5000, format = int32, default = 5000

        • qPopulateMissing boolean

          If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

          default = false

        • qShowTotalsAbove boolean

          If set to true, the total (if any) is shown on the first row. The default value is false.

          default = false

        • qIndentMode boolean

          This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

          default = false

        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qSortbyYValue integer

          To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

          default = 0, format = int8, default = 0

        • qTitle object
          Show qTitle properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qColumnOrder array of integers

          The order of the columns.

        • qExpansionState array of objects
          Experimental

          Expansion state per dimension for pivot mode ( qMode is P).

          Show qExpansionState properties
          • qExcludeList boolean
          • qPos object
            Show qPos properties
            • qDimName string
            • qElemNo array of integers
            • qElemValues array of strings
        • qDynamicScript array of strings
          Experimental

          Hypercube Modifier Dynamic script string

        • qContextSetExpression string

          Set expression valid for the whole cube, limiting computations to the specified set.

        • qSuppressMeasureTotals boolean

          When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
      • qLayoutExclude object

        Contains JSON to be excluded from validation.

      • qListObjectDef object

        Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

        Show qListObjectDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qAutoSortByState object
          Show qAutoSortByState properties
          • qDisplayNumberOfRows integer

            This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

            format = int32

        • qFrequencyMode string

          Can be one of: "N""V""P""R"

        • qShowAlternatives boolean

          If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

        • qInitialDataFetch array of objects

          Fetches an initial data set.

          Show qInitialDataFetch properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qExpressions array of objects

          Lists the expressions in the list object. This parameter is optional.

          Show qExpressions properties
          • qExpr string

            Value of the expression.

          • qLibraryId string

            Refers to an expression stored in the library.
        • qDirectQuerySimplifiedView boolean
          Experimental

          If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
      • qMeasureListDef object

        Defines the list of measures.

        Show qMeasureListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qMediaListDef object

        Defines the list of media files.

        This struct is deprecated.

        Properties

        "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

      • qNxLibraryDimensionDef object
        Show qNxLibraryDimensionDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of dimension names.

        • qFieldLabels array of strings

          Array of dimension labels.

        • qLabelExpression string
        • qAlias string

          Alias of the dimension.

        • qScriptGenerated boolean Deprecated

          default = false

        • qOrigin string

          Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

      • qNxLibraryMeasureDef object
        Show qNxLibraryMeasureDef properties
        • qLabel string

          Label of the measure.

        • qDef string

          Definition of the measure.

        • qGrouping string

          Can be one of: "N""H""C"

        • qExpressions array of strings

          Array of expressions.

        • qActiveExpression integer

          Index to the active expression in a measure.

          format = int32

        • qLabelExpression string

          Optional expression used for dynamic label.

        • qNumFormat object

          Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

          Formatting mechanism

          The formatting mechanism depends on the type set in qType, as shown below:

          In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

          Type is DATE, TIME, TIMESTAMP or INTERVAL

          The following applies:

          • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
          • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
          • The properties qDec , qThou , qnDec , qUseThou are not used.

          Type is INTEGER

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

          Type is REAL

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
          • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
          • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is FIX

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is MONEY

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
          • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

          Type is ASCII

          No formatting, qFmt is ignored.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qScriptGenerated boolean Deprecated

          default = false

        • qOrigin string

          Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

      • qSelectionObjectDef object

        To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

        Properties

        "qSelectionObjectDef": {}

        Show qSelectionObjectDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .
      • qStaticContentUrlDef object
        In addition, this structure can contain dynamic properties.
        Show qStaticContentUrlDef properties
        • qUrl string

          Relative path of the thumbnail.
      • qStringExpression object

        Properties

        Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

        • < expression > is a string
        The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
        A string expression is not evaluated, if the expression is surrounded by simple quotes.
        The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
        Show qStringExpression properties
        • qExpr string
      • qTreeDataDef object

        Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

        Show qTreeDataDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qDimensions array of objects

          Array of dimensions.

          Show qDimensions properties
          • qLibraryId string

            Refers to a dimension stored in the library.

          • qDef object
            Show qDef properties
            • qGrouping string

              Can be one of: "N""H""C"

            • qFieldDefs array of strings

              Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

            • qFieldLabels array of strings

              Array of field labels. This parameter is optional.

            • qSortCriterias array of objects

              Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

              Show qSortCriterias properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qNumberPresentations array of objects

              Defines the format of the value. This parameter is optional.

              Show qNumberPresentations properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveField integer

              Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

              format = int32

            • qLabelExpression string

              Label expression. This parameter is optional.

            • qAlias string

              Alias of the dimension.
          • qValueExprs array of objects

            List of measures.

            Show qValueExprs properties
            • qLibraryId string

              Refers to a measure stored in the library.

            • qDef object
              Show qDef properties
              • qLabel string

                Name of the measure. An empty string is returned as a default value. This parameter is optional.

              • qDescription string

                Description of the measure. An empty string is returned as a default value. This parameter is optional.

              • qTags array of strings

                Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

              • qGrouping string

                Can be one of: "N""H""C"

              • qDef string

                Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRelative boolean

                If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

              • qBrutalSum boolean

                If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

              • qAggrFunc string

                Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

              • qAccumulate integer
                • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

                format = int32

              • qReverseSort boolean

                If set to true, it inverts the sort criteria in the field.

              • qActiveExpression integer

                Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

                format = int32

              • qExpressions array of strings

                Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

              • qLabelExpression string

                Label expression. This parameter is optional.
            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qAttributeDimensions array of objects

              List of attribute dimensions.

              Show qAttributeDimensions properties
              • qDef string

                Expression or field name.

              • qLibraryId string

                LibraryId for dimension.

              • qSortBy object
                Show qSortBy properties
                • qSortByState integer

                  Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                  format = int8

                • qSortByFrequency integer

                  Sorts the field values by frequency (number of occurrences in the field).

                  format = int8

                • qSortByNumeric integer

                  Sorts the field values by numeric value.

                  format = int8

                • qSortByAscii integer

                  Sorts the field by alphabetical order.

                  format = int8

                • qSortByLoadOrder integer

                  Sorts the field values by the initial load order.

                  format = int8

                • qSortByExpression integer

                  Sorts the field by expression.

                  format = int8

                • qExpression object
                  Show qExpression properties
                  • qv string

                    Expression evaluated to dual.
                • qSortByGreyness integer

                  format = int8

              • qAttribute boolean

                If set to true, this attribute will not affect the number of rows in the cube.
            • qCalcCond object
              Show qCalcCond properties
              • qv string

                Expression evaluated to dual.
            • qCalcCondition object
              Show qCalcCondition properties
              • qCond object
                Show qCond properties
                • qv string

                  Expression evaluated to dual.
              • qMsg object
                Show qMsg properties
                • qv string

                  Expression evaluated to string.
            • qTrendLines array of objects
              Experimental

              Specifies trendlines for this measure.

              Show qTrendLines properties
              • qType string

                Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

              • qXColIx integer

                The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

                default = -1, format = int32, default = -1

              • qCalcR2 boolean

                Set to true to calulatate the R2 score

                default = false

              • qContinuousXAxis string

                Can be one of: "Never""Possible""Time"

              • qMultiDimMode string

                Can be one of: "Multi""Sum"

            • qMiniChartDef object
              Show qMiniChartDef properties
              • qDef string

                Expression or field name.

              • qLibraryId string

                LibraryId for dimension.

              • qSortBy object
                Show qSortBy properties
                • qSortByState integer

                  Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                  format = int8

                • qSortByFrequency integer

                  Sorts the field values by frequency (number of occurrences in the field).

                  format = int8

                • qSortByNumeric integer

                  Sorts the field values by numeric value.

                  format = int8

                • qSortByAscii integer

                  Sorts the field by alphabetical order.

                  format = int8

                • qSortByLoadOrder integer

                  Sorts the field values by the initial load order.

                  format = int8

                • qSortByExpression integer

                  Sorts the field by expression.

                  format = int8

                • qExpression object
                  Show qExpression properties
                  • qv string

                    Expression evaluated to dual.
                • qSortByGreyness integer

                  format = int8

              • qOtherTotalSpec object
                Show qOtherTotalSpec properties
                • qOtherMode string

                  Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

                • qOtherCounted object
                  Show qOtherCounted properties
                  • qv string

                    Expression evaluated to dual.
                • qOtherLimit object
                  Show qOtherLimit properties
                  • qv string

                    Expression evaluated to dual.
                • qOtherLimitMode string

                  Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

                • qSuppressOther boolean

                  If set to true, the group Others is not displayed as a dimension value. The default value is false.

                  default = false

                • qForceBadValueKeeping boolean

                  This parameter is used when qOtherMode is set to:

                  • OTHER_ABS_LIMITED
                  • OTHER_REL_LIMITED
                  • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                  and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                  default = true

                • qApplyEvenWhenPossiblyWrongResult boolean

                  Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                  default = true

                • qGlobalOtherGrouping boolean

                  This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                  default = false

                • qOtherCollapseInnerDimensions boolean

                  If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                  default = false

                • qOtherSortMode string

                  Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

                • qTotalMode string

                  Can be one of: "TOTAL_OFF""TOTAL_EXPR"

                • qReferencedExpression object
                  Show qReferencedExpression properties
                  • qv string

                    Expression evaluated to string.
              • qMaxNumberPoints integer

                default = -1, format = int32, default = -1

              • qAttributeExpressions array of objects

                List of attribute expressions.

                Show qAttributeExpressions properties
                • qExpression string

                  Definition of the attribute expression. Example: "Max(OrderID)"

                • qLibraryId string

                  Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

                • qAttribute boolean

                  If set to true, this measure will not affect the number of rows in the cube.

                • qNumFormat object

                  Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                  Formatting mechanism

                  The formatting mechanism depends on the type set in qType, as shown below:

                  In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                  Type is DATE, TIME, TIMESTAMP or INTERVAL

                  The following applies:

                  • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                  • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                  • The properties qDec , qThou , qnDec , qUseThou are not used.

                  Type is INTEGER

                  The following applies:

                  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                  • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                  Type is REAL

                  The following applies:

                  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                  • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                  • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                  • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                  Type is FIX

                  The following applies:

                  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                  • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                  Type is MONEY

                  The following applies:

                  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                  • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                  Type is ASCII

                  No formatting, qFmt is ignored.

                  Show qNumFormat properties
                  • qType string

                    Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                  • qnDec integer

                    Number of decimals. Default is 10.

                    default = 10, format = int32, default = 10

                  • qUseThou integer

                    Defines whether or not a thousands separator must be used. Default is 0.

                    default = 0, format = int32, default = 0

                  • qFmt string

                    Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                  • qDec string

                    Defines the decimal separator. Example: .

                  • qThou string

                    Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
                • qLabel string

                  Label of the attribute expression.

                • qLabelExpression string

                  Optional expression used for dynamic label.
              • qNullSuppression boolean

                If set to true, no null values are returned.
          • qNullSuppression boolean

            If set to true, no null values are returned.

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qShowAll boolean

            If set to true, all dimension values are shown.

          • qOtherLabel object
            Show qOtherLabel properties
            • qv string

              Expression evaluated to string.
          • qTotalLabel object
            Show qTotalLabel properties
            • qv string

              Expression evaluated to string.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
        • qInterColumnSortOrder array of integers

          Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

        • qSuppressZero boolean

          Removes zero values.

          default = false

        • qSuppressMissing boolean

          Removes missing values.

          default = false

        • qOpenFullyExpanded boolean

          If this property is set to true, the cells are opened expanded. The default value is false.

          default = false

        • qPopulateMissing boolean

          If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

          default = false

        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTitle object
          Show qTitle properties
          • qv string

            Expression evaluated to string.
        • qInitialDataFetch array of objects

          Initial data set. This property is optional.

          Show qInitialDataFetch properties
          • qMaxNbrOfNodes integer

            Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

            format = int32

          • qTreeNodes array of objects

            Defines areas of the tree to be fetched. Areas must be defined left to right.

            Show qTreeNodes properties
            • qArea object
              Show qArea properties
              • qLeft integer

                Position from the left. Corresponds to the first column.

                format = int32

              • qTop integer

                Position from the top. Corresponds to the first row.

                format = int32

              • qWidth integer

                Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

                format = int32

              • qHeight integer

                Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

                format = int32

            • qAllValues boolean

              When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
          • qTreeLevels object
            Show qTreeLevels properties
            • qLeft integer

              The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

              format = int32

            • qDepth integer

              Number of dimensions to include in the tree.

              default = -1, format = int32, default = -1

        • qExpansionState array of objects
          Experimental

          Expansion state per dimension.

          Show qExpansionState properties
          • qExcludeList boolean
          • qPos object
            Show qPos properties
            • qDimName string
            • qElemNo array of integers
            • qElemValues array of strings
        • qValueExprs array of objects

          List of measures to calculate on the whole tree.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qContextSetExpression string

          Set expression valid for the whole cube, limiting computations to the specified set.
      • qUndoInfoDef object

        Defines if an object should contain information on the number of possible undo and redo.

        Properties

        "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

      • qValueExpression object

        Properties

        Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

        • < expression > is a string.
        The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
        The expression is evaluated as a numeric.
        Show qValueExpression properties
        • qExpr string
      • qVariableListDef object

        Defines the list of variables in an app.

        Show qVariableListDef properties
        • qType string

          Type of variables to include in the list.

        • qShowReserved boolean

          Shows the reserved variables if set to true.

        • qShowConfig boolean

          Shows the system variables if set to true.

        • qData object

          Contains dynamic JSON data specified by the client.

        • qShowSession boolean

          Shows the session variables if set to true.
      Show additional optional properties
      • object object
        Private
        Any of:
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
    • qChildren array of undefineds

      Information about the children of the generic object.

    • qEmbeddedSnapshotRef object
      Show qEmbeddedSnapshotRef properties
      • qProperties object
        Show qProperties properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qMetaDef object

          Used to collect metadata.

          Properties

          Semantic type with an empty structure.

        • qIncludeVariables boolean
          Experimental

          If true all variables will be stored in the bookmark.

          default = false

        • qDistinctValues boolean
          Experimental

          If true all selected values will be stored distinct, i.e. searchstrings will not be kept.

          default = false

      • qBookmark object
        Show qBookmark properties
        • qStateData array of objects

          List of selections for each state.

          Show qStateData properties
          • qStateName string

            Name of the alternate state. Default is current selections: $

          • qFieldItems array of objects

            List of the selections.

            Show qFieldItems properties
            • qDef object
              Show qDef properties
              • qName string

                Name of the field.

              • qType string

                Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

            • qLocked boolean

              Indicates if the field is locked. Default is false.

            • qSelectInfo object
              Show qSelectInfo properties
              • qTextSearch string

                Text search string. Everything that matches the text is selected. This parameter is optional.

              • qRangeLo number

                Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qNumberFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumberFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRangeInfo array of objects

                This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

                Show qRangeInfo properties
                • qRangeLo number

                  Lowest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qRangeHi number

                  Highest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qMeasure string

                  Label of the measure.
              • qSoftLock boolean

                Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

                default = false

              • qContinuousRangeInfo array of objects

                List of information about ranges for selections.

                Show qContinuousRangeInfo properties
                • qMin number

                  Lowest value in the range

                  format = double

                • qMax number

                  Highest value in the range

                  format = double

                • qMinInclEq boolean

                  If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

                • qMaxInclEq boolean

                  If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
              • qSelectFieldSearch boolean

                This parameter is true if the TextSearch is a result of a Select Field operation.

                default = false

            • qValues array of objects
              Show qValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qExcludedValues array of objects

              List of excluded values. Either the list of selected values or the list of excluded values is displayed.

              Show qExcludedValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qAndMode boolean

              If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

            • qOneAndOnlyOne boolean

              If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

            • qValuesCount integer

              Count of selected values. Indicates if the Values field is loaded.

              default = -1, format = int32, default = -1

            • qExcludedValuesCount integer

              Count of excluded values. Indicates if the ExcludedValues field is loaded.

              default = -1, format = int32, default = -1

        • qUtcModifyTime number

          Time when the bookmark was created.

          format = double

        • qVariableItems array of objects

          List of the variables in the app at the time the bookmark was created.

          Show qVariableItems properties
          • qName string

            Name of the variable.

          • qValue object
            Show qValue properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qDefinition string

            The Reporting mode definition of the variable.
        • qPatches array of objects

          Softpatches to be applied with this bookmark.

          Show qPatches properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qPatches array of objects

            Array with patches.

            Show qPatches properties
            • qOp string

              Can be one of: "add""remove""replace"

            • qPath string

              Path to the property to add, remove or replace.

            • qValue string

              This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
          • qChildren array of undefineds

            Array with child objects and their patches.
        • qCyclicGroupStates array of objects

          Information about cyclic groups by zero-based index. This field is unused.

          Show qCyclicGroupStates properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qActiveField integer

            Active field of the cyclic group, identified by a zero-based index.

            format = int32

        • qGroupStates array of objects
          Experimental

          Information about cyclic groups indexed by field definition.

          Show qGroupStates properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qActiveFieldDef string

            String defining the active field.
      • qClassicBookmark object
        Show qClassicBookmark properties
        • qId string
        • qName string
        • qUtcModifyTime number

          format = double

        • qUtcRecallTime number

          format = double

        • qRecallCount integer

          format = int32

        • qApplyAdditive boolean
        • qFieldItems array of objects
          Show qFieldItems properties
          • qDef object
            Show qDef properties
            • qName string

              Name of the field.

            • qType string

              Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

          • qLocked boolean

            Indicates if the field is locked. Default is false.

          • qSelectInfo object
            Show qSelectInfo properties
            • qTextSearch string

              Text search string. Everything that matches the text is selected. This parameter is optional.

            • qRangeLo number

              Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qNumberFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumberFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRangeInfo array of objects

              This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

              Show qRangeInfo properties
              • qRangeLo number

                Lowest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qMeasure string

                Label of the measure.
            • qSoftLock boolean

              Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

              default = false

            • qContinuousRangeInfo array of objects

              List of information about ranges for selections.

              Show qContinuousRangeInfo properties
              • qMin number

                Lowest value in the range

                format = double

              • qMax number

                Highest value in the range

                format = double

              • qMinInclEq boolean

                If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

              • qMaxInclEq boolean

                If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
            • qSelectFieldSearch boolean

              This parameter is true if the TextSearch is a result of a Select Field operation.

              default = false

          • qValues array of objects
            Show qValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qExcludedValues array of objects

            List of excluded values. Either the list of selected values or the list of excluded values is displayed.

            Show qExcludedValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qAndMode boolean

            If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

          • qOneAndOnlyOne boolean

            If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

          • qValuesCount integer

            Count of selected values. Indicates if the Values field is loaded.

            default = -1, format = int32, default = -1

          • qExcludedValuesCount integer

            Count of excluded values. Indicates if the ExcludedValues field is loaded.

            default = -1, format = int32, default = -1

        • qVariableItems array of objects
          Show qVariableItems properties
          • qName string

            Name of the variable.

          • qValue object
            Show qValue properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qDefinition string

            The Reporting mode definition of the variable.
        • qSheetId string
        • qObjects array of objects
          Show qObjects properties
          • qId string
          • qActive boolean
          • qShowMode integer

            format = byte

          • qScrollPos object
            Show qScrollPos properties
            • qUsePosition boolean
            • qPos object
              Show qPos properties
              • qx integer

                x-coordinate in pixels. The origin is the top left of the screen.

                format = int32

              • qy integer

                y-coordinate in pixels. The origin is the top left of the screen.

                format = int32

        • qApplyLayoutState boolean

          default = false

        • qShowPopupInfo boolean

          default = false

        • qInfoText string
        • qOwner string
        • qGroups array of objects
          Show qGroups properties
          • qId string
          • qCyclePos integer

            format = int32

        • qShow object
          Show qShow properties
          • qAlways boolean

            default = true

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
        • qApplyInputFieldValues boolean

          default = true

        • qInputFieldItems array of objects
          Show qInputFieldItems properties
          • qFieldName string
          • qValues array of objects
            Show qValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qPackedHashKeys array of integers
        • qObjectsLayout array of objects
          Show qObjectsLayout properties
          • qId string
          • qActive boolean
          • qShowMode integer

            format = byte

          • qScrollPos object
            Show qScrollPos properties
            • qUsePosition boolean
            • qPos object
              Show qPos properties
              • qx integer

                x-coordinate in pixels. The origin is the top left of the screen.

                format = int32

              • qy integer

                y-coordinate in pixels. The origin is the top left of the screen.

                format = int32

          • qExpansionInfo array of objects
            Show qExpansionInfo properties
            • qExcludeList boolean
            • qPos object
              Show qPos properties
              • qDimName string
              • qElemNo array of integers
              • qElemValues array of strings
          • qLeftCollapsed boolean
          • qTopCollapsed boolean
          • qSortData array of objects
            Show qSortData properties
            • qName string
            • qReversed boolean
          • qDimensionGroupPos array of objects
            Show qDimensionGroupPos properties
            • qGroupName string
            • qCurrentItemName string
          • qExpressionGroupPos array of objects
            Show qExpressionGroupPos properties
            • qGroupName string
            • qCurrentItemName string
          • qUseGraphMode boolean
          • qGraphMode string

            Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"

          • qActiveContainerChildObjectId string
          • qExtendedPivotState object
            Show qExtendedPivotState properties
            • qExpressionPosition integer

              format = byte

            • qNumberOfLeftDimensions integer

              format = byte

            • qDimensionNames array of strings
            • qEnableConditions array of strings
        • qIncludeSelectionState boolean

          default = true

        • qIncludeScrollPosition boolean
        • qAlternateStateData array of objects
          Show qAlternateStateData properties
          • qStateName string

            Name of the alternate state. Default is current selections: $

          • qFieldItems array of objects

            List of the selections.

            Show qFieldItems properties
            • qDef object
              Show qDef properties
              • qName string

                Name of the field.

              • qType string

                Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

            • qLocked boolean

              Indicates if the field is locked. Default is false.

            • qSelectInfo object
              Show qSelectInfo properties
              • qTextSearch string

                Text search string. Everything that matches the text is selected. This parameter is optional.

              • qRangeLo number

                Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qNumberFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumberFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRangeInfo array of objects

                This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

                Show qRangeInfo properties
                • qRangeLo number

                  Lowest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qRangeHi number

                  Highest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qMeasure string

                  Label of the measure.
              • qSoftLock boolean

                Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

                default = false

              • qContinuousRangeInfo array of objects

                List of information about ranges for selections.

                Show qContinuousRangeInfo properties
                • qMin number

                  Lowest value in the range

                  format = double

                • qMax number

                  Highest value in the range

                  format = double

                • qMinInclEq boolean

                  If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

                • qMaxInclEq boolean

                  If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
              • qSelectFieldSearch boolean

                This parameter is true if the TextSearch is a result of a Select Field operation.

                default = false

            • qValues array of objects
              Show qValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qExcludedValues array of objects

              List of excluded values. Either the list of selected values or the list of excluded values is displayed.

              Show qExcludedValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qAndMode boolean

              If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

            • qOneAndOnlyOne boolean

              If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

            • qValuesCount integer

              Count of selected values. Indicates if the Values field is loaded.

              default = -1, format = int32, default = -1

            • qExcludedValuesCount integer

              Count of excluded values. Indicates if the ExcludedValues field is loaded.

              default = -1, format = int32, default = -1

        • qForAnnotations boolean
        • qIncludeAllVariables boolean

          default = false

      • qClassicMetadata object
        Show qClassicMetadata properties
        • qShared boolean
        • qUtcModifyTime number

          format = double

        • qSheetId string
        • qTemporary boolean
        • qRestrictedAccess boolean
        • qAccessList array of strings
        • qPersonalEditionHash_OBSOLETE string
        • qHidden boolean

          default = false

        • qLinkedTo array of strings

Errors

array
GenericErrors

GetFullPropertyTree()

enigma.js
const result = await genericObject.getFullPropertyTree()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetFullPropertyTree"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qPropEntry": {
      "qProperty": {
        "qInfo": {
          "qId": "value",
          "qType": "value"
        },
        "qExtendsId": "value",
        "qMetaDef": {},
        "qStateName": "value",
        "qAppObjectListDef": {
          "qType": "value",
          "qData": {}
        },
        "qBookmarkListDef": {
          "qType": "value",
          "qData": {},
          "qIncludePatches": true
        },
        "qChildListDef": {
          "qData": {}
        },
        "qDimensionListDef": {
          "qType": "value",
          "qData": {}
        },
        "qEmbeddedSnapshotDef": {},
        "qExtensionListDef": {},
        "qFieldListDef": {
          "qShowSystem": false,
          "qShowHidden": false,
          "qShowSemantic": false,
          "qShowSrcTables": false,
          "qShowDefinitionOnly": false,
          "qShowDerivedFields": false,
          "qShowImplicit": false
        },
        "qHyperCubeDef": {
          "qStateName": "value",
          "qDimensions": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qGrouping": "N",
                "qFieldDefs": [
                  "value"
                ],
                "qFieldLabels": [
                  "value"
                ],
                "qSortCriterias": [
                  {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  }
                ],
                "qNumberPresentations": [
                  {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  }
                ],
                "qReverseSort": true,
                "qActiveField": 123,
                "qLabelExpression": "value",
                "qAlias": "value"
              },
              "qNullSuppression": true,
              "qIncludeElemValue": true,
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qShowTotal": true,
              "qShowAll": true,
              "qOtherLabel": {
                "qv": "value"
              },
              "qTotalLabel": {
                "qv": "value"
              },
              "qCalcCond": {
                "qv": "value"
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ],
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              }
            }
          ],
          "qMeasures": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qLabel": "value",
                "qDescription": "value",
                "qTags": [
                  "value"
                ],
                "qGrouping": "N",
                "qDef": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRelative": true,
                "qBrutalSum": true,
                "qAggrFunc": "value",
                "qAccumulate": 123,
                "qReverseSort": true,
                "qActiveExpression": 123,
                "qExpressions": [
                  "value"
                ],
                "qLabelExpression": "value"
              },
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ],
              "qCalcCond": {
                "qv": "value"
              },
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              },
              "qTrendLines": [
                {
                  "qType": "AVERAGE",
                  "qXColIx": -1,
                  "qCalcR2": false,
                  "qContinuousXAxis": "Never",
                  "qMultiDimMode": "Multi"
                }
              ],
              "qMiniChartDef": {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qOtherTotalSpec": {
                  "qOtherMode": "OTHER_OFF",
                  "qOtherCounted": {
                    "qv": "value"
                  },
                  "qOtherLimit": {
                    "qv": "value"
                  },
                  "qOtherLimitMode": "OTHER_GE_LIMIT",
                  "qSuppressOther": false,
                  "qForceBadValueKeeping": true,
                  "qApplyEvenWhenPossiblyWrongResult": true,
                  "qGlobalOtherGrouping": false,
                  "qOtherCollapseInnerDimensions": false,
                  "qOtherSortMode": "OTHER_SORT_DEFAULT",
                  "qTotalMode": "TOTAL_OFF",
                  "qReferencedExpression": {
                    "qv": "value"
                  }
                },
                "qMaxNumberPoints": -1,
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qNullSuppression": true
              }
            }
          ],
          "qInterColumnSortOrder": [
            123
          ],
          "qSuppressZero": false,
          "qSuppressMissing": false,
          "qInitialDataFetch": [
            {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            }
          ],
          "qReductionMode": "N",
          "qMode": "S",
          "qPseudoDimPos": -1,
          "qNoOfLeftDims": -1,
          "qAlwaysFullyExpanded": false,
          "qMaxStackedCells": 5000,
          "qPopulateMissing": false,
          "qShowTotalsAbove": false,
          "qIndentMode": false,
          "qCalcCond": {
            "qv": "value"
          },
          "qSortbyYValue": 0,
          "qTitle": {
            "qv": "value"
          },
          "qCalcCondition": {
            "qCond": {
              "qv": "value"
            },
            "qMsg": {
              "qv": "value"
            }
          },
          "qColumnOrder": [
            123
          ],
          "qExpansionState": [
            {
              "qExcludeList": true,
              "qPos": {
                "qDimName": "value",
                "qElemNo": [
                  123
                ],
                "qElemValues": [
                  "value"
                ]
              }
            }
          ],
          "qDynamicScript": [
            "value"
          ],
          "qContextSetExpression": "value",
          "qSuppressMeasureTotals": true
        },
        "qLayoutExclude": {},
        "qListObjectDef": {
          "qStateName": "value",
          "qLibraryId": "value",
          "qDef": {
            "qGrouping": "N",
            "qFieldDefs": [
              "value"
            ],
            "qFieldLabels": [
              "value"
            ],
            "qSortCriterias": [
              {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              }
            ],
            "qNumberPresentations": [
              {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              }
            ],
            "qReverseSort": true,
            "qActiveField": 123,
            "qLabelExpression": "value",
            "qAlias": "value"
          },
          "qAutoSortByState": {
            "qDisplayNumberOfRows": 123
          },
          "qFrequencyMode": "N",
          "qShowAlternatives": true,
          "qInitialDataFetch": [
            {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            }
          ],
          "qExpressions": [
            {
              "qExpr": "value",
              "qLibraryId": "value"
            }
          ],
          "qDirectQuerySimplifiedView": true
        },
        "qMeasureListDef": {
          "qType": "value",
          "qData": {}
        },
        "qMediaListDef": {},
        "qNxLibraryDimensionDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qLabelExpression": "value",
          "qAlias": "value",
          "qScriptGenerated": false,
          "qOrigin": "PROGRAM"
        },
        "qNxLibraryMeasureDef": {
          "qLabel": "value",
          "qDef": "value",
          "qGrouping": "N",
          "qExpressions": [
            "value"
          ],
          "qActiveExpression": 123,
          "qLabelExpression": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qScriptGenerated": false,
          "qOrigin": "PROGRAM"
        },
        "qSelectionObjectDef": {
          "qStateName": "value"
        },
        "qStaticContentUrlDef": {
          "qUrl": "value"
        },
        "qStringExpression": {
          "qExpr": "value"
        },
        "qTreeDataDef": {
          "qStateName": "value",
          "qDimensions": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qGrouping": "N",
                "qFieldDefs": [
                  "value"
                ],
                "qFieldLabels": [
                  "value"
                ],
                "qSortCriterias": [
                  {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  }
                ],
                "qNumberPresentations": [
                  {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  }
                ],
                "qReverseSort": true,
                "qActiveField": 123,
                "qLabelExpression": "value",
                "qAlias": "value"
              },
              "qValueExprs": [
                {
                  "qLibraryId": "value",
                  "qDef": {
                    "qLabel": "value",
                    "qDescription": "value",
                    "qTags": [
                      "value"
                    ],
                    "qGrouping": "N",
                    "qDef": "value",
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qRelative": true,
                    "qBrutalSum": true,
                    "qAggrFunc": "value",
                    "qAccumulate": 123,
                    "qReverseSort": true,
                    "qActiveExpression": 123,
                    "qExpressions": [
                      "value"
                    ],
                    "qLabelExpression": "value"
                  },
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qAttributeDimensions": [
                    {
                      "qDef": "value",
                      "qLibraryId": "value",
                      "qSortBy": {
                        "qSortByState": 123,
                        "qSortByFrequency": 123,
                        "qSortByNumeric": 123,
                        "qSortByAscii": 123,
                        "qSortByLoadOrder": 123,
                        "qSortByExpression": 123,
                        "qExpression": {
                          "qv": "value"
                        },
                        "qSortByGreyness": 123
                      },
                      "qAttribute": true
                    }
                  ],
                  "qCalcCond": {
                    "qv": "value"
                  },
                  "qCalcCondition": {
                    "qCond": {
                      "qv": "value"
                    },
                    "qMsg": {
                      "qv": "value"
                    }
                  },
                  "qTrendLines": [
                    {
                      "qType": "AVERAGE",
                      "qXColIx": -1,
                      "qCalcR2": false,
                      "qContinuousXAxis": "Never",
                      "qMultiDimMode": "Multi"
                    }
                  ],
                  "qMiniChartDef": {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qOtherTotalSpec": {
                      "qOtherMode": "OTHER_OFF",
                      "qOtherCounted": {
                        "qv": "value"
                      },
                      "qOtherLimit": {
                        "qv": "value"
                      },
                      "qOtherLimitMode": "OTHER_GE_LIMIT",
                      "qSuppressOther": false,
                      "qForceBadValueKeeping": true,
                      "qApplyEvenWhenPossiblyWrongResult": true,
                      "qGlobalOtherGrouping": false,
                      "qOtherCollapseInnerDimensions": false,
                      "qOtherSortMode": "OTHER_SORT_DEFAULT",
                      "qTotalMode": "TOTAL_OFF",
                      "qReferencedExpression": {
                        "qv": "value"
                      }
                    },
                    "qMaxNumberPoints": -1,
                    "qAttributeExpressions": [
                      {
                        "qExpression": "value",
                        "qLibraryId": "value",
                        "qAttribute": true,
                        "qNumFormat": {
                          "qType": "U",
                          "qnDec": 10,
                          "qUseThou": 0,
                          "qFmt": "value",
                          "qDec": "value",
                          "qThou": "value"
                        },
                        "qLabel": "value",
                        "qLabelExpression": "value"
                      }
                    ],
                    "qNullSuppression": true
                  }
                }
              ],
              "qNullSuppression": true,
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qShowAll": true,
              "qOtherLabel": {
                "qv": "value"
              },
              "qTotalLabel": {
                "qv": "value"
              },
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ]
            }
          ],
          "qInterColumnSortOrder": [
            123
          ],
          "qSuppressZero": false,
          "qSuppressMissing": false,
          "qOpenFullyExpanded": false,
          "qPopulateMissing": false,
          "qCalcCondition": {
            "qCond": {
              "qv": "value"
            },
            "qMsg": {
              "qv": "value"
            }
          },
          "qTitle": {
            "qv": "value"
          },
          "qInitialDataFetch": [
            {
              "qMaxNbrOfNodes": 123,
              "qTreeNodes": [
                {
                  "qArea": {
                    "qLeft": 123,
                    "qTop": 123,
                    "qWidth": 123,
                    "qHeight": 123
                  },
                  "qAllValues": true
                }
              ],
              "qTreeLevels": {
                "qLeft": 123,
                "qDepth": -1
              }
            }
          ],
          "qExpansionState": [
            {
              "qExcludeList": true,
              "qPos": {
                "qDimName": "value",
                "qElemNo": [
                  123
                ],
                "qElemValues": [
                  "value"
                ]
              }
            }
          ],
          "qValueExprs": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qLabel": "value",
                "qDescription": "value",
                "qTags": [
                  "value"
                ],
                "qGrouping": "N",
                "qDef": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRelative": true,
                "qBrutalSum": true,
                "qAggrFunc": "value",
                "qAccumulate": 123,
                "qReverseSort": true,
                "qActiveExpression": 123,
                "qExpressions": [
                  "value"
                ],
                "qLabelExpression": "value"
              },
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ],
              "qCalcCond": {
                "qv": "value"
              },
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              },
              "qTrendLines": [
                {
                  "qType": "AVERAGE",
                  "qXColIx": -1,
                  "qCalcR2": false,
                  "qContinuousXAxis": "Never",
                  "qMultiDimMode": "Multi"
                }
              ],
              "qMiniChartDef": {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qOtherTotalSpec": {
                  "qOtherMode": "OTHER_OFF",
                  "qOtherCounted": {
                    "qv": "value"
                  },
                  "qOtherLimit": {
                    "qv": "value"
                  },
                  "qOtherLimitMode": "OTHER_GE_LIMIT",
                  "qSuppressOther": false,
                  "qForceBadValueKeeping": true,
                  "qApplyEvenWhenPossiblyWrongResult": true,
                  "qGlobalOtherGrouping": false,
                  "qOtherCollapseInnerDimensions": false,
                  "qOtherSortMode": "OTHER_SORT_DEFAULT",
                  "qTotalMode": "TOTAL_OFF",
                  "qReferencedExpression": {
                    "qv": "value"
                  }
                },
                "qMaxNumberPoints": -1,
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qNullSuppression": true
              }
            }
          ],
          "qContextSetExpression": "value"
        },
        "qUndoInfoDef": {},
        "qValueExpression": {
          "qExpr": "value"
        },
        "qVariableListDef": {
          "qType": "value",
          "qShowReserved": true,
          "qShowConfig": true,
          "qData": {},
          "qShowSession": true
        }
      },
      "qChildren": [],
      "qEmbeddedSnapshotRef": {
        "qProperties": {
          "qInfo": {
            "qId": "value",
            "qType": "value"
          },
          "qMetaDef": {},
          "qIncludeVariables": false,
          "qDistinctValues": false
        },
        "qBookmark": {
          "qStateData": [
            {
              "qStateName": "value",
              "qFieldItems": [
                {
                  "qDef": {
                    "qName": "value",
                    "qType": "NOT_PRESENT"
                  },
                  "qLocked": true,
                  "qSelectInfo": {
                    "qTextSearch": "value",
                    "qRangeLo": -1e+300,
                    "qRangeHi": -1e+300,
                    "qNumberFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qRangeInfo": [
                      {
                        "qRangeLo": -1e+300,
                        "qRangeHi": -1e+300,
                        "qMeasure": "value"
                      }
                    ],
                    "qSoftLock": false,
                    "qContinuousRangeInfo": [
                      {
                        "qMin": 123,
                        "qMax": 123,
                        "qMinInclEq": true,
                        "qMaxInclEq": true
                      }
                    ],
                    "qSelectFieldSearch": false
                  },
                  "qValues": [
                    {
                      "qText": "value",
                      "qIsNumeric": true,
                      "qNumber": 123
                    }
                  ],
                  "qExcludedValues": [
                    {
                      "qText": "value",
                      "qIsNumeric": true,
                      "qNumber": 123
                    }
                  ],
                  "qAndMode": true,
                  "qOneAndOnlyOne": true,
                  "qValuesCount": -1,
                  "qExcludedValuesCount": -1
                }
              ]
            }
          ],
          "qUtcModifyTime": 123,
          "qVariableItems": [
            {
              "qName": "value",
              "qValue": {
                "qText": "value",
                "qIsNumeric": true,
                "qNumber": 123
              },
              "qDefinition": "value"
            }
          ],
          "qPatches": [
            {
              "qInfo": {
                "qId": "value",
                "qType": "value"
              },
              "qPatches": [
                {
                  "qOp": "add",
                  "qPath": "value",
                  "qValue": "value"
                }
              ],
              "qChildren": []
            }
          ],
          "qCyclicGroupStates": [
            {
              "qInfo": {
                "qId": "value",
                "qType": "value"
              },
              "qActiveField": 123
            }
          ],
          "qGroupStates": [
            {
              "qInfo": {
                "qId": "value",
                "qType": "value"
              },
              "qActiveFieldDef": "value"
            }
          ]
        },
        "qClassicBookmark": {
          "qId": "value",
          "qName": "value",
          "qUtcModifyTime": 123,
          "qUtcRecallTime": 123,
          "qRecallCount": 123,
          "qApplyAdditive": true,
          "qFieldItems": [
            {
              "qDef": {
                "qName": "value",
                "qType": "NOT_PRESENT"
              },
              "qLocked": true,
              "qSelectInfo": {
                "qTextSearch": "value",
                "qRangeLo": -1e+300,
                "qRangeHi": -1e+300,
                "qNumberFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRangeInfo": [
                  {
                    "qRangeLo": -1e+300,
                    "qRangeHi": -1e+300,
                    "qMeasure": "value"
                  }
                ],
                "qSoftLock": false,
                "qContinuousRangeInfo": [
                  {
                    "qMin": 123,
                    "qMax": 123,
                    "qMinInclEq": true,
                    "qMaxInclEq": true
                  }
                ],
                "qSelectFieldSearch": false
              },
              "qValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qExcludedValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qAndMode": true,
              "qOneAndOnlyOne": true,
              "qValuesCount": -1,
              "qExcludedValuesCount": -1
            }
          ],
          "qVariableItems": [
            {
              "qName": "value",
              "qValue": {
                "qText": "value",
                "qIsNumeric": true,
                "qNumber": 123
              },
              "qDefinition": "value"
            }
          ],
          "qSheetId": "value",
          "qObjects": [
            {
              "qId": "value",
              "qActive": true,
              "qShowMode": 123,
              "qScrollPos": {
                "qUsePosition": true,
                "qPos": {
                  "qx": 123,
                  "qy": 123
                }
              }
            }
          ],
          "qApplyLayoutState": false,
          "qShowPopupInfo": false,
          "qInfoText": "value",
          "qOwner": "value",
          "qGroups": [
            {
              "qId": "value",
              "qCyclePos": 123
            }
          ],
          "qShow": {
            "qAlways": true,
            "qExpression": {
              "qv": "value"
            }
          },
          "qApplyInputFieldValues": true,
          "qInputFieldItems": [
            {
              "qFieldName": "value",
              "qValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qPackedHashKeys": [
                123
              ]
            }
          ],
          "qObjectsLayout": [
            {
              "qId": "value",
              "qActive": true,
              "qShowMode": 123,
              "qScrollPos": {
                "qUsePosition": true,
                "qPos": {
                  "qx": 123,
                  "qy": 123
                }
              },
              "qExpansionInfo": [
                {
                  "qExcludeList": true,
                  "qPos": {
                    "qDimName": "value",
                    "qElemNo": [
                      123
                    ],
                    "qElemValues": [
                      "value"
                    ]
                  }
                }
              ],
              "qLeftCollapsed": true,
              "qTopCollapsed": true,
              "qSortData": [
                {
                  "qName": "value",
                  "qReversed": true
                }
              ],
              "qDimensionGroupPos": [
                {
                  "qGroupName": "value",
                  "qCurrentItemName": "value"
                }
              ],
              "qExpressionGroupPos": [
                {
                  "qGroupName": "value",
                  "qCurrentItemName": "value"
                }
              ],
              "qUseGraphMode": true,
              "qGraphMode": "GRAPH_MODE_BAR",
              "qActiveContainerChildObjectId": "value",
              "qExtendedPivotState": {
                "qExpressionPosition": 123,
                "qNumberOfLeftDimensions": 123,
                "qDimensionNames": [
                  "value"
                ],
                "qEnableConditions": [
                  "value"
                ]
              }
            }
          ],
          "qIncludeSelectionState": true,
          "qIncludeScrollPosition": true,
          "qAlternateStateData": [
            {
              "qStateName": "value",
              "qFieldItems": [
                {
                  "qDef": {
                    "qName": "value",
                    "qType": "NOT_PRESENT"
                  },
                  "qLocked": true,
                  "qSelectInfo": {
                    "qTextSearch": "value",
                    "qRangeLo": -1e+300,
                    "qRangeHi": -1e+300,
                    "qNumberFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qRangeInfo": [
                      {
                        "qRangeLo": -1e+300,
                        "qRangeHi": -1e+300,
                        "qMeasure": "value"
                      }
                    ],
                    "qSoftLock": false,
                    "qContinuousRangeInfo": [
                      {
                        "qMin": 123,
                        "qMax": 123,
                        "qMinInclEq": true,
                        "qMaxInclEq": true
                      }
                    ],
                    "qSelectFieldSearch": false
                  },
                  "qValues": [
                    {
                      "qText": "value",
                      "qIsNumeric": true,
                      "qNumber": 123
                    }
                  ],
                  "qExcludedValues": [
                    {
                      "qText": "value",
                      "qIsNumeric": true,
                      "qNumber": 123
                    }
                  ],
                  "qAndMode": true,
                  "qOneAndOnlyOne": true,
                  "qValuesCount": -1,
                  "qExcludedValuesCount": -1
                }
              ]
            }
          ],
          "qForAnnotations": true,
          "qIncludeAllVariables": false
        },
        "qClassicMetadata": {
          "qShared": true,
          "qUtcModifyTime": 123,
          "qSheetId": "value",
          "qTemporary": true,
          "qRestrictedAccess": true,
          "qAccessList": [
            "value"
          ],
          "qPersonalEditionHash_OBSOLETE": "value",
          "qHidden": false,
          "qLinkedTo": [
            "value"
          ]
        }
      }
    }
  }
}

GenericObject GetHyperCubeBinnedData

(qPath, qPages, qViewport, qDataRanges, qMaxNbrCells, qQueryLevel, qBinningMethod)

This method supports data binning. When a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points. A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the qQueryLevel parameter) or coarsened (for zoom out). The grid of cells is adaptive (not static), meaning that it adapts to different length scales. The GetHyperCubeBinnedData method gives information about the adaptive grid and the values of the generic object. The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned. Dimension values and measure values are rendered at point level (highest detailed level).

The generic object should contain two or three measures and one dimension. When the refinement is high, the first two measures are represented on the x-axis and on the y-axis, while the third measure is visualized as color or point size.

Adaptive Grid

More details about the properties of the adaptive grid are given in this paragraph. When the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays. The first array contains the following properties:

Name Description Type
qNum Maximum number of points that a cell can contain. String
qElemNumber Is set to 0. Boolean
qState The default value is L. One of:
  • L for Locked
  • S for Selected
  • O for Optional
  • D for Deselected
  • A for Alternative
  • X for eXcluded
  • XS for eXcluded Selected
  • XL for eXcluded Locked

The next arrays give the coordinates of each cell in the page. Each array contains the following properties:

Name Description Type
qText Coordinates of a cell in the measure range.
“qText”: “[[<left>, <top>, <right>, <bottom>], [<left>, <top>, <right>, <bottom>], .... [<left>, <top>, <right>, <bottom>]]
Where:
< left >, < top >, < right > and < bottom > are the coordinates of the cell in the measure range.		 String
qNum Number of points in the cell. Double precision floating point
qElemNumber Unique identifier for each cell, calculated by the engine during the construction of the grid.
This element number is not stored in the database and can have a positive or a negative value.		 Integer
qState The default value is L. One of:
  • L for Locked
  • S for Selected
  • O for Optional
  • D for Deselected
  • A for Alternative
  • X for eXcluded
  • XS for eXcluded Selected
  • XL for eXcluded Locked
Cells are represented as rectangles.

Dimension values and measures values

More details about the properties, when dimension and measure values are returned, are given in this paragraph. When the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned. The first array is empty because no information on the adaptive grid is needed. The next arrays bring information about the dimension and the measure values.

Name Description Type
qText Text value of the dimension or the measure. String
qNum Numerical value of the dimension or the measure.
Is set to 0 if the value is only text.		 Double precision floating point
qElemNumber Unique identifier for each cell, calculated by the engine during the construction of the grid.
This element number is not stored in the database and can have a positive or a negative value.		 Integer
qState The default value is L. One of:
  • L for Locked
  • S for Selected
  • O for Optional
  • D for Deselected
  • A for Alternative
  • X for eXcluded
  • XS for eXcluded Selected
  • XL for eXcluded Locked

Parameters

  • qPath string
    Required

    Path to the definition of the object. For example, /qHyperCubeDef .

  • qPages array of objects
    Required

    Array of pages to retrieve. Since the generic object contains two measures and one dimension, qWidth should be set to 3. If the value of a measure is Null, the value cannot be rendered. Therefore, the number of elements rendered in a page can be less than the number defined in the property qHeight .

    Show qPages properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qViewport object
    Required

    Defines the canvas and the zoom level. This parameter is not yet used and is optional.

    Show qViewport properties
    • qWidth integer

      Width of the canvas in pixels.

      format = int32

    • qHeight integer

      Height of the canvas in pixels.

      format = int32

    • qZoomLevel integer

      Zoom level.

      format = int32

  • qDataRanges array of objects
    Required

    Range of the data to render. This range applies to the measure values. The lowest and highest values of a measure can be retrieved by using the GetLayout method (in /qHyperCube/qMeasureInfo ).

    Show qDataRanges properties
    • qLeft number

      Position from the left. Corresponds to the lowest possible value of the first measure (the measure on the x-axis).

      format = double

    • qTop number

      Position from the top. Corresponds to the highest possible value of the second measure (the measure on the y-axis).

      format = double

    • qWidth number

      Width of the page. Corresponds to the highest possible value of the first measure (the measure on the x-axis).

      format = double

    • qHeight number

      Height of the page. The difference between qTop and qHeight gives the lowest possible value of the second measure (the measure on the y-axis).

      format = double

  • qMaxNbrCells integer
    Required

    Maximum number of cells in the grid.

  • qQueryLevel integer
    Required

    Level of details. The higher the level, the more detailed information you get (zoom-in). When the number of points to render falls below a certain threshold, the values are no longer rendered as cells but as points. The query level should be no greater than 20.

  • qBinningMethod integer
    Required

    Selects the algorithm. The default value is 0. One of:

    • 0: Adaptive grid
    • 1: Hexagonal grid
    • 2: Uniform grid

Response

  • qDataPages array of objects
    Show qDataPages properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text. This parameter is optional.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmpty boolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCell boolean

        Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

      • qIsOtherCell boolean

        Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

      • qFrequency string

        Frequency of the value. This parameter is optional.

      • qHighlightRanges object
        Show qHighlightRanges properties
        • qRanges array of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPos integer

            Position of the first search occurrence.

            format = int32

          • qCharCount integer

            Number of occurrences found.

            format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qIsNull boolean

        Is set to true if the value is Null.

      • qMiniChart object
        Show qMiniChart properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

        • qMin number

          format = double

        • qMax number

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
      • qInExtRow boolean
    • qTails array of objects

      Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

      Show qTails properties
      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

        format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qIsReduced boolean

      Is set to true, if the data have been reduced. The default value is false.

      default = false

Errors

array
GenericErrors

GetHyperCubeBinnedData(qPath, qPages, qViewport, qDataRanges, qMaxNbrCells, qQueryLevel, qBinningMethod)

enigma.js
const result = await genericObject.getHyperCubeBinnedData("value", [
  {
    "qLeft": 123,
    "qTop": 123,
    "qWidth": 123,
    "qHeight": 123
  }
], {
  "qWidth": 123,
  "qHeight": 123,
  "qZoomLevel": 123
}, [
  {
    "qLeft": 123,
    "qTop": 123,
    "qWidth": 123,
    "qHeight": 123
  }
], 123, 123, 123)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetHyperCubeBinnedData",
  "params": {
    "qPath": "value",
    "qPages": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qViewport": {
      "qWidth": 123,
      "qHeight": 123,
      "qZoomLevel": 123
    },
    "qDataRanges": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qMaxNbrCells": 123,
    "qQueryLevel": 123,
    "qBinningMethod": 123
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qDataPages": [
      {
        "qMatrix": [
          [
            {
              "qText": "value",
              "qNum": 123,
              "qElemNumber": 123,
              "qState": "L",
              "qIsEmpty": true,
              "qIsTotalCell": true,
              "qIsOtherCell": true,
              "qFrequency": "value",
              "qHighlightRanges": {
                "qRanges": [
                  {
                    "qCharPos": 123,
                    "qCharCount": 123
                  }
                ]
              },
              "qAttrExps": {
                "qValues": [
                  {
                    "qText": "value",
                    "qNum": 123
                  }
                ]
              },
              "qAttrDims": {
                "qValues": [
                  {
                    "qText": "value",
                    "qElemNo": 123
                  }
                ]
              },
              "qIsNull": true,
              "qMiniChart": {
                "qMatrix": [
                  [
                    {
                      "qText": "value",
                      "qNum": 123,
                      "qElemNumber": 123,
                      "qAttrExps": {
                        "qValues": [
                          {
                            "qText": "value",
                            "qNum": 123
                          }
                        ]
                      }
                    }
                  ]
                ],
                "qMin": 123,
                "qMax": 123,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                }
              },
              "qInExtRow": true
            }
          ]
        ],
        "qTails": [
          {
            "qUp": 123,
            "qDown": 123
          }
        ],
        "qArea": {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        },
        "qIsReduced": false
      }
    ]
  }
}

GenericObject GetHyperCubeContinuousData

(qPath, qOptions, qReverseSort?)

Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.

Binning is done on the time stamp data as well as the date. This means that you can zoom in to a level of granularity as low as seconds.

Parameters

  • qPath string
    Required

    Path to the definition of the object. For example, /qHyperCubeDef .

  • qOptions object
    Required

    Defines the data to return.

    Show qOptions properties
    • qStart number

      Start value.

      format = double

    • qEnd number

      End value.

      format = double

    • qNbrPoints integer

      Number of bins for binning.

      format = int32

    • qMaxNbrTicks integer

      Maximum number of ticks.

      format = int32

    • qMaxNumberLines integer

      Maximum number of lines.

      default = -1, format = int32, default = -1

  • qReverseSort boolean

    If set to true the returned data pages are reverse sorted. Optional.

Response

  • qDataPages array of objects
    Show qDataPages properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text. This parameter is optional.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmpty boolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCell boolean

        Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

      • qIsOtherCell boolean

        Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

      • qFrequency string

        Frequency of the value. This parameter is optional.

      • qHighlightRanges object
        Show qHighlightRanges properties
        • qRanges array of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPos integer

            Position of the first search occurrence.

            format = int32

          • qCharCount integer

            Number of occurrences found.

            format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qIsNull boolean

        Is set to true if the value is Null.

      • qMiniChart object
        Show qMiniChart properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

        • qMin number

          format = double

        • qMax number

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
      • qInExtRow boolean
    • qTails array of objects

      Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

      Show qTails properties
      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

        format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qIsReduced boolean

      Is set to true, if the data have been reduced. The default value is false.

      default = false

  • qAxisData object
    Show qAxisData properties
    • qAxis array of objects

      List of axis data.

      Show qAxis properties
      • qName string

        Name of the derived definition.

      • qTags array of strings

        List of tags.

      • qTicks array of objects

        List of ticks.

        Show qTicks properties
        • qText string

          Tick's label.

        • qStart number

          Start value.

          format = double

        • qEnd number

          End value.

          format = double

Errors

array
GenericErrors

GetHyperCubeContinuousData(qPath, qOptions, qReverseSort?)

enigma.js
const result = await genericObject.getHyperCubeContinuousData("value", {
  "qStart": 123,
  "qEnd": 123,
  "qNbrPoints": 123,
  "qMaxNbrTicks": 123,
  "qMaxNumberLines": -1
}, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetHyperCubeContinuousData",
  "params": {
    "qPath": "value",
    "qOptions": {
      "qStart": 123,
      "qEnd": 123,
      "qNbrPoints": 123,
      "qMaxNbrTicks": 123,
      "qMaxNumberLines": -1
    },
    "qReverseSort": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qDataPages": [
      {
        "qMatrix": [
          [
            {
              "qText": "value",
              "qNum": 123,
              "qElemNumber": 123,
              "qState": "L",
              "qIsEmpty": true,
              "qIsTotalCell": true,
              "qIsOtherCell": true,
              "qFrequency": "value",
              "qHighlightRanges": {
                "qRanges": [
                  {
                    "qCharPos": 123,
                    "qCharCount": 123
                  }
                ]
              },
              "qAttrExps": {
                "qValues": [
                  {
                    "qText": "value",
                    "qNum": 123
                  }
                ]
              },
              "qAttrDims": {
                "qValues": [
                  {
                    "qText": "value",
                    "qElemNo": 123
                  }
                ]
              },
              "qIsNull": true,
              "qMiniChart": {
                "qMatrix": [
                  [
                    {
                      "qText": "value",
                      "qNum": 123,
                      "qElemNumber": 123,
                      "qAttrExps": {
                        "qValues": [
                          {
                            "qText": "value",
                            "qNum": 123
                          }
                        ]
                      }
                    }
                  ]
                ],
                "qMin": 123,
                "qMax": 123,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                }
              },
              "qInExtRow": true
            }
          ]
        ],
        "qTails": [
          {
            "qUp": 123,
            "qDown": 123
          }
        ],
        "qArea": {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        },
        "qIsReduced": false
      }
    ],
    "qAxisData": {
      "qAxis": [
        {
          "qName": "value",
          "qTags": [
            "value"
          ],
          "qTicks": [
            {
              "qText": "value",
              "qStart": 123,
              "qEnd": 123
            }
          ]
        }
      ]
    }
  }
}

GenericObject GetHyperCubeData

(qPath, qPages)

Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.

This method works for a hypercube in DATA_MODE_STRAIGHT.
A data set is returned.

Limitations on the number of cells

The maximum for the combined total number of cells across all pages is:

  • 10,000 cells. If this limit is exceeded, a calc-pages-too-large error with code 7009 is returned.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qPages array of objects
    Required

    Array of pages to retrieve.

    Show qPages properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

Response

  • qDataPages array of objects
    Show qDataPages properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text. This parameter is optional.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmpty boolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCell boolean

        Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

      • qIsOtherCell boolean

        Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

      • qFrequency string

        Frequency of the value. This parameter is optional.

      • qHighlightRanges object
        Show qHighlightRanges properties
        • qRanges array of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPos integer

            Position of the first search occurrence.

            format = int32

          • qCharCount integer

            Number of occurrences found.

            format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qIsNull boolean

        Is set to true if the value is Null.

      • qMiniChart object
        Show qMiniChart properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

        • qMin number

          format = double

        • qMax number

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
      • qInExtRow boolean
    • qTails array of objects

      Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

      Show qTails properties
      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

        format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qIsReduced boolean

      Is set to true, if the data have been reduced. The default value is false.

      default = false

Errors

array
GenericErrors

GetHyperCubeData(qPath, qPages)

enigma.js
const result = await genericObject.getHyperCubeData("value", [
  {
    "qLeft": 123,
    "qTop": 123,
    "qWidth": 123,
    "qHeight": 123
  }
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetHyperCubeData",
  "params": {
    "qPath": "value",
    "qPages": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qDataPages": [
      {
        "qMatrix": [
          [
            {
              "qText": "value",
              "qNum": 123,
              "qElemNumber": 123,
              "qState": "L",
              "qIsEmpty": true,
              "qIsTotalCell": true,
              "qIsOtherCell": true,
              "qFrequency": "value",
              "qHighlightRanges": {
                "qRanges": [
                  {
                    "qCharPos": 123,
                    "qCharCount": 123
                  }
                ]
              },
              "qAttrExps": {
                "qValues": [
                  {
                    "qText": "value",
                    "qNum": 123
                  }
                ]
              },
              "qAttrDims": {
                "qValues": [
                  {
                    "qText": "value",
                    "qElemNo": 123
                  }
                ]
              },
              "qIsNull": true,
              "qMiniChart": {
                "qMatrix": [
                  [
                    {
                      "qText": "value",
                      "qNum": 123,
                      "qElemNumber": 123,
                      "qAttrExps": {
                        "qValues": [
                          {
                            "qText": "value",
                            "qNum": 123
                          }
                        ]
                      }
                    }
                  ]
                ],
                "qMin": 123,
                "qMax": 123,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                }
              },
              "qInExtRow": true
            }
          ]
        ],
        "qTails": [
          {
            "qUp": 123,
            "qDown": 123
          }
        ],
        "qArea": {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        },
        "qIsReduced": false
      }
    ]
  }
}

GenericObject GetHyperCubePivotData

(qPath, qPages)

Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.

This method works for a hypercube in DATA_MODE_PIVOT.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qPages array of objects
    Required

    Array of pages to retrieve.

    Show qPages properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

Response

  • qDataPages array of objects
    Show qDataPages properties
    • qLeft array of objects

      Information about the left dimension values of a pivot table.

      Show qLeft properties
      • qText string

        Some text.

      • qElemNo integer

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpand boolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapse boolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

        format = int32

      • qSubNodes array of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qTop array of objects

      Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.

      Show qTop properties
      • qText string

        Some text.

      • qElemNo integer

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpand boolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapse boolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

        format = int32

      • qSubNodes array of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qData array of arrays

      Array of data.

      Show qData properties
      • qLabel string

        Label of the cell. This parameter is optional.

      • qText string

        Some text related to the cell.

      • qNum number

        Value of the cell.

        format = double

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

Errors

array
GenericErrors

GetHyperCubePivotData(qPath, qPages)

enigma.js
const result = await genericObject.getHyperCubePivotData("value", [
  {
    "qLeft": 123,
    "qTop": 123,
    "qWidth": 123,
    "qHeight": 123
  }
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetHyperCubePivotData",
  "params": {
    "qPath": "value",
    "qPages": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qDataPages": [
      {
        "qLeft": [
          {
            "qText": "value",
            "qElemNo": 123,
            "qValue": 123,
            "qCanExpand": true,
            "qCanCollapse": true,
            "qType": "V",
            "qUp": 123,
            "qDown": 123,
            "qSubNodes": [],
            "qAttrExps": {
              "qValues": [
                {
                  "qText": "value",
                  "qNum": 123
                }
              ]
            },
            "qAttrDims": {
              "qValues": [
                {
                  "qText": "value",
                  "qElemNo": 123
                }
              ]
            }
          }
        ],
        "qTop": [
          {
            "qText": "value",
            "qElemNo": 123,
            "qValue": 123,
            "qCanExpand": true,
            "qCanCollapse": true,
            "qType": "V",
            "qUp": 123,
            "qDown": 123,
            "qSubNodes": [],
            "qAttrExps": {
              "qValues": [
                {
                  "qText": "value",
                  "qNum": 123
                }
              ]
            },
            "qAttrDims": {
              "qValues": [
                {
                  "qText": "value",
                  "qElemNo": 123
                }
              ]
            }
          }
        ],
        "qData": [
          [
            {
              "qLabel": "value",
              "qText": "value",
              "qNum": 123,
              "qType": "V",
              "qAttrExps": {
                "qValues": [
                  {
                    "qText": "value",
                    "qNum": 123
                  }
                ]
              },
              "qAttrDims": {
                "qValues": [
                  {
                    "qText": "value",
                    "qElemNo": 123
                  }
                ]
              }
            }
          ]
        ],
        "qArea": {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        }
      }
    ]
  }
}

GenericObject GetHyperCubeReducedData

(qPath, qPages, qZoomFactor, qReductionMode)

Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them. The reduction is dependent on the zoom factor (parameter qZoomFactor ) and on the reduction mode.

This method can be used to create mini charts.

Bar chart or line chart data reduction

For the data reduction to happen, the following conditions must be fulfilled:

  • The values cannot fit in the defined page (parameter qPages ).
  • The zoom factor is not 0 (parameter qZoomFactor ).
  • The reduction mode must be set to D1.

The reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.

Example

If you have a chart with 1 million data, and you have set the zoom factor to 5, the GetHyperCubeReducedData method reduces the chart and retrieves 200 000 data.

Scatter plot chart data reduction

The reduction mode must be set to C. This reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid. The number of centroids can be defined in the parameter qZoomFactor.

Scatter plot chart resolution reduction

The reduction mode must be set to S. The resolution is reduced according to the zoom factor (parameter qZoomFactor ).

Example

If you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qPages array of objects
    Required

    Array of pages.

    Show qPages properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qZoomFactor integer
    Required

    Defines the zoom factor. If set to -1, the engine decides of the zoom factor.

    • If the reduction mode is D1 or S , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32.
    • If the reduction mode is C , the zoom factor defines the number of centroids.
  • qReductionMode string
    Required

    Defines the reduction mode.

    One of:

    • N or DATA_REDUCTION_NONE
    • D1 or DATA_REDUCTION_ONEDIM
    • S or DATA_REDUCTION_SCATTERED
    • C or DATA_REDUCTION_CLUSTERED
    • ST or DATA_REDUCTION_STACKED

Response

  • qDataPages array of objects
    Show qDataPages properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text. This parameter is optional.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmpty boolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCell boolean

        Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

      • qIsOtherCell boolean

        Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

      • qFrequency string

        Frequency of the value. This parameter is optional.

      • qHighlightRanges object
        Show qHighlightRanges properties
        • qRanges array of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPos integer

            Position of the first search occurrence.

            format = int32

          • qCharCount integer

            Number of occurrences found.

            format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qIsNull boolean

        Is set to true if the value is Null.

      • qMiniChart object
        Show qMiniChart properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

        • qMin number

          format = double

        • qMax number

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
      • qInExtRow boolean
    • qTails array of objects

      Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

      Show qTails properties
      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

        format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qIsReduced boolean

      Is set to true, if the data have been reduced. The default value is false.

      default = false

Errors

array
GenericErrors

GetHyperCubeReducedData(qPath, qPages, qZoomFactor, qReductionMode)

enigma.js
const result = await genericObject.getHyperCubeReducedData("value", [
  {
    "qLeft": 123,
    "qTop": 123,
    "qWidth": 123,
    "qHeight": 123
  }
], 123, "value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetHyperCubeReducedData",
  "params": {
    "qPath": "value",
    "qPages": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qZoomFactor": 123,
    "qReductionMode": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qDataPages": [
      {
        "qMatrix": [
          [
            {
              "qText": "value",
              "qNum": 123,
              "qElemNumber": 123,
              "qState": "L",
              "qIsEmpty": true,
              "qIsTotalCell": true,
              "qIsOtherCell": true,
              "qFrequency": "value",
              "qHighlightRanges": {
                "qRanges": [
                  {
                    "qCharPos": 123,
                    "qCharCount": 123
                  }
                ]
              },
              "qAttrExps": {
                "qValues": [
                  {
                    "qText": "value",
                    "qNum": 123
                  }
                ]
              },
              "qAttrDims": {
                "qValues": [
                  {
                    "qText": "value",
                    "qElemNo": 123
                  }
                ]
              },
              "qIsNull": true,
              "qMiniChart": {
                "qMatrix": [
                  [
                    {
                      "qText": "value",
                      "qNum": 123,
                      "qElemNumber": 123,
                      "qAttrExps": {
                        "qValues": [
                          {
                            "qText": "value",
                            "qNum": 123
                          }
                        ]
                      }
                    }
                  ]
                ],
                "qMin": 123,
                "qMax": 123,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                }
              },
              "qInExtRow": true
            }
          ]
        ],
        "qTails": [
          {
            "qUp": 123,
            "qDown": 123
          }
        ],
        "qArea": {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        },
        "qIsReduced": false
      }
    ]
  }
}

GenericObject GetHyperCubeStackData

(qPath, qPages, qMaxNbrCells?)

Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.

This method works for a hypercube in DATA_MODE_PIVOT_STACK.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qPages array of objects
    Required

    Array of pages to retrieve.

    Show qPages properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

  • qMaxNbrCells integer

    Maximum number of cells at outer level. The default value is 10 000.

Response

  • qDataPages array of objects
    Show qDataPages properties
    • qData array of objects

      Array of data.

      Show qData properties
      • qText string

        Some text.

      • qElemNo integer

        Rank number of the value. If set to -1, it means that the value is not an element number.

        format = int32

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qCanExpand boolean

        If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

      • qCanCollapse boolean

        If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

      • qType string

        Can be one of: "V""E""N""T""O""A""P""R""U""G"

      • qMaxPos number

        Total of the positive values in the current group of cells.

        format = double

      • qMinNeg number

        Total of the negative values in the current group of cells.

        format = double

      • qUp integer

        Number of elements that are part of the previous tail.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail.

        format = int32

      • qRow integer

        Row index in the data matrix. The indexing starts from 0.

        format = int32

      • qSubNodes array of undefineds

        Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

Errors

array
GenericErrors

GetHyperCubeStackData(qPath, qPages, qMaxNbrCells?)

enigma.js
const result = await genericObject.getHyperCubeStackData("value", [
  {
    "qLeft": 123,
    "qTop": 123,
    "qWidth": 123,
    "qHeight": 123
  }
], 123)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetHyperCubeStackData",
  "params": {
    "qPath": "value",
    "qPages": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qMaxNbrCells": 123
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qDataPages": [
      {
        "qData": [
          {
            "qText": "value",
            "qElemNo": 123,
            "qValue": 123,
            "qCanExpand": true,
            "qCanCollapse": true,
            "qType": "V",
            "qMaxPos": 123,
            "qMinNeg": 123,
            "qUp": 123,
            "qDown": 123,
            "qRow": 123,
            "qSubNodes": [],
            "qAttrExps": {
              "qValues": [
                {
                  "qText": "value",
                  "qNum": 123
                }
              ]
            },
            "qAttrDims": {
              "qValues": [
                {
                  "qText": "value",
                  "qElemNo": 123
                }
              ]
            }
          }
        ],
        "qArea": {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        }
      }
    ]
  }
}

GenericObject GetHyperCubeTreeData

(qPath, qNodeOptions?)

Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.

This method works for a treedata object or a hypercube in DATA_MODE_TREE.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected.

  • qNodeOptions object

    Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned.

    Show qNodeOptions properties
    • qMaxNbrOfNodes integer

      Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

      format = int32

    • qTreeNodes array of objects

      Defines areas of the tree to be fetched. Areas must be defined left to right.

      Show qTreeNodes properties
      • qArea object
        Show qArea properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qAllValues boolean

        When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
    • qTreeLevels object
      Show qTreeLevels properties
      • qLeft integer

        The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

        format = int32

      • qDepth integer

        Number of dimensions to include in the tree.

        default = -1, format = int32, default = -1

Response

  • qNodes array of objects

    Represents a dimension in the tree.

    Show qNodes properties
    • qText string

      The text version of the value, if available.

    • qValue number

      Value of the cell. Is set to NaN , if the value is not a number.

      format = double

    • qElemNo integer

      Element number.

      format = int32

    • qGroupPos integer

      The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

      format = int32

    • qGroupSize integer

      Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

      format = int32

    • qRow integer

      Row index in the data matrix. The indexing starts from 0.

      format = int32

    • qType string

      Can be one of: "V""E""N""T""O""A""P""R""U""G"

    • qValues array of objects

      The measures for this node.

      Show qValues properties
      • qText string

        The text version of the value, if available.

      • qValue number

        Value of the cell. Is set to NaN , if the value is not a number.

        format = double

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

    • qNodes array of undefineds

      The children of this node in the fetched tree structure.

    • qAttrExps object
      Show qAttrExps properties
      • qValues array of objects

        List of attribute expressions values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value.

        • qNum number

          Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

          format = double

    • qAttrDims object
      Show qAttrDims properties
      • qValues array of objects

        List of values.

        Show qValues properties
        • qText string

          Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

        • qElemNo integer

          Element number.

          format = int32

    • qMaxPos array of numbers

      Total of the positive values in the current group of cells.

    • qMinNeg array of numbers

      Total of the negative values in the current group of cells.

    • qCanExpand boolean

      If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

    • qCanCollapse boolean

      If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

    • qState string

      Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

    • qTreePath array of integers

      The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.

Errors

array
GenericErrors

GetHyperCubeTreeData(qPath, qNodeOptions?)

enigma.js
const result = await genericObject.getHyperCubeTreeData("value", {
  "qMaxNbrOfNodes": 123,
  "qTreeNodes": [
    {
      "qArea": {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      },
      "qAllValues": true
    }
  ],
  "qTreeLevels": {
    "qLeft": 123,
    "qDepth": -1
  }
})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetHyperCubeTreeData",
  "params": {
    "qPath": "value",
    "qNodeOptions": {
      "qMaxNbrOfNodes": 123,
      "qTreeNodes": [
        {
          "qArea": {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          },
          "qAllValues": true
        }
      ],
      "qTreeLevels": {
        "qLeft": 123,
        "qDepth": -1
      }
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qNodes": [
      {
        "qText": "value",
        "qValue": 123,
        "qElemNo": 123,
        "qGroupPos": 123,
        "qGroupSize": 123,
        "qRow": 123,
        "qType": "V",
        "qValues": [
          {
            "qText": "value",
            "qValue": 123,
            "qAttrExps": {
              "qValues": [
                {
                  "qText": "value",
                  "qNum": 123
                }
              ]
            },
            "qAttrDims": {
              "qValues": [
                {
                  "qText": "value",
                  "qElemNo": 123
                }
              ]
            }
          }
        ],
        "qNodes": [],
        "qAttrExps": {
          "qValues": [
            {
              "qText": "value",
              "qNum": 123
            }
          ]
        },
        "qAttrDims": {
          "qValues": [
            {
              "qText": "value",
              "qElemNo": 123
            }
          ]
        },
        "qMaxPos": [
          123
        ],
        "qMinNeg": [
          123
        ],
        "qCanExpand": true,
        "qCanCollapse": true,
        "qState": "L",
        "qTreePath": [
          123
        ]
      }
    ]
  }
}

GenericObject GetInfo

()

Returns the type and identifier of the object.

Response

  • qInfo object
    Show qInfo properties
    • qId string

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qType string

      Type of the object. This parameter is mandatory.

Errors

array
GenericErrors

GetInfo()

enigma.js
const result = await genericObject.getInfo()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetInfo"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qInfo": {
      "qId": "value",
      "qType": "value"
    }
  }
}

GenericObject GetLayout

()

Evaluates an object and displays its properties including the dynamic properties. If the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.

Example:

A is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E. A GetLayout call on A returns information on the objects A, B and C. A GetLayout call on B returns information on the objects B, D and E. A  GetLayout call on C returns information on the object C.

In addition to the parameters displayed above, the **GetLayout** method can return other properties according to what is defined in the generic object. For example, if **qHyperCubeDef** is defined in the generic object, the **GetLayout** method returns the properties described in _HyperCube_.

Response

  • qLayout object

    Is the layout for GenericObjectProperties.

    Show qLayout properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qMeta object

      Layout for NxMetaDef.

      Show qMeta properties
      • qName string

        Name. This property is optional.
    • qExtendsId string

      Should be set to create an object that is linked to another object. Enter the identifier of the object you want to link to. If you do not want to link your object, set this parameter to an empty string.

    • qHasSoftPatches boolean

      Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied).

    • qError object
      Show qError properties
      • qErrorCode integer

        Error code.

        format = int32

    • qSelectionInfo object
      Show qSelectionInfo properties
      • qInSelections boolean

        Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections Method.

      • qMadeSelections boolean

        Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see BeginSelections Method.
    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qAppObjectList object

      Lists the app objects. Is the layout for AppObjectListDef.

      An app object is a generic object created at app level.
      Show qAppObjectList properties
      • qItems array of objects

        Information about the list of dimensions.

        Show qItems properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qMeta object

          Layout for NxMetaDef.

          Show qMeta properties
          • qName string

            Name. This property is optional.
        • qData object

          Contains dynamic JSON data specified by the client.
    • qBookmarkList object

      Lists the bookmarks. Is the layout for BookmarkListDef.

      Show qBookmarkList properties
      • qItems array of objects

        Information about the list of bookmarks.

        Show qItems properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qMeta object

          Layout for NxMetaDef.

          Show qMeta properties
          • qName string

            Name. This property is optional.
        • qData object

          Contains dynamic JSON data specified by the client.
    • qChildList object

      Lists the children of a generic object. Is the layout for ChildListDef.

      ChildList is used by the _GetLayout Method_ to list the children of a generic object.
      Show qChildList properties
      • qItems array of objects

        Information about the items in the app object.

        Show qItems properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qMeta object

          Layout for NxMetaDef.

          Show qMeta properties
          • qName string

            Name. This property is optional.
        • qData object

          Contains dynamic JSON data specified by the client.
    • qDimensionList object

      Lists the dimensions. Is the layout for DimensionListDef.

      Show qDimensionList properties
      • qItems array of objects

        Information about the list of dimensions.

        Show qItems properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qMeta object

          Layout for NxMetaDef.

          Show qMeta properties
          • qName string

            Name. This property is optional.
        • qData object

          Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshot object

      Renders the embedded snapshot in an object. The following is returned:

      • Any dynamic properties defined in the bookmark
      • Any properties defined in qEmbeddedSnapshot

      Properties

      "qEmbeddedSnapshot": {}

    • qExtensionList object

      Obsolete, use qrs API's to fetch extensions.

      Show qExtensionList properties
      • qItems array of strings
    • qFieldList object

      Lists the fields present in the data model viewer. Is the layout for FieldListDef.

      Show qFieldList properties
      • qItems array of objects

        Array of items.

        Show qItems properties
        • qIsSemantic boolean

          If set to true, it means that the field is a semantic.

        • qIsHidden boolean

          If set to true, it means that the field is hidden.

        • qIsSystem boolean

          If set to true, it means that the field is a system field.

        • qAndMode boolean

          If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false.

        • qName string

          Name of the field

        • qCardinal integer

          Number of distinct field values

          format = int32

        • qTags array of strings

          Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII

        • qIsDefinitionOnly boolean

          If set to true, it means that the field is a field on the fly.

        • qDerivedFieldData object
          Show qDerivedFieldData properties
          • qDerivedFieldLists array of objects

            Information about the derived fields.

            Show qDerivedFieldLists properties
            • qDerivedDefinitionName string

              Name of the derived definition.

            • qFieldDefs array of objects

              List of the derived fields.

              Show qFieldDefs properties
              • qId string

                Identifier of the derived field. The identifier is unique.

              • qName string

                Combination of field name, definition and method. Example: OrderDate.MyDefinition.Year

              • qMethod string

                Method name associated to the derived field.

              • qExpr string

                Expression of the derived field. Example: If qName is OrderDate.MyDefinition.Year , the expression is as follows: =${Mydefinition(OrderDate).Year}

              • qTags array of strings

                List of tags.
            • qGroupDefs array of objects

              List of the derived groups.

              Show qGroupDefs properties
              • qId string

                Identifier of the group.

              • qName string

                Name of the derived group.

              • qGrouping string

                Can be one of: "N""H""C"

              • qFieldDefs array of strings

                List of the derived fields in the group.
            • qTags array of strings

              List of tags on the derived fields.
        • qIsDetail boolean

          Is used for Direct Discovery. If set to true, it means that the type of the field is detail.

        • qIsImplicit boolean

          Is used for Direct Discovery. If set to true, it means that the type of the field is measure.

        • qReadableName string
    • qHyperCube object

      Renders the properties of a hypercube. Is the layout for HyperCubeDef. For more information about the definition of a hypercube, see Generic object.

      What is returned in HyperCube depends on the type of the hypercube (straight, pivot or stacked table, or tree) and on the method called (GetLayout, GetHyperCubeData, GetHyperCubePivotData, GetHyperCubeStackData, GetHyperCubeTreeData).
      Show qHyperCube properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qSize object
        Show qSize properties
        • qcx integer

          Number of pixels on the x axis.

          format = int32

        • qcy integer

          Number of pixels on the y axis.

          format = int32

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qDimensionInfo array of objects

        Information on the dimension.

        Show qDimensionInfo properties
        • qFallbackTitle string

          Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used.

        • qApprMaxGlyphCount integer

          Length of the longest value in the field.

          format = int32

        • qCardinal integer Deprecated

          Number of distinct field values.

          format = int32

        • qLocked boolean

          Is set to true if the field is locked.

        • qSortIndicator string

          Can be one of: "N""A""D"

        • qGroupFallbackTitles array of strings

          Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group).

        • qGroupPos integer

          Index of the dimension that is currently in use. qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups.

          format = int32

        • qStateCounts object
          Show qStateCounts properties
          • qLocked integer

            Number of values in locked state.

            format = int32

          • qSelected integer

            Number of values in selected state.

            format = int32

          • qOption integer

            Number of values in optional state.

            format = int32

          • qDeselected integer

            Number of values in deselected state.

            format = int32

          • qAlternative integer

            Number of values in alternative state.

            format = int32

          • qExcluded integer

            Number of values in excluded state.

            format = int32

          • qSelectedExcluded integer

            Number of values in selected excluded state.

            format = int32

          • qLockedExcluded integer

            Number of values in locked excluded state.

            format = int32

        • qTags array of strings

          Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qDimensionType string

          Can be one of: "D""N""T"

        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qGrouping string

          Can be one of: "N""H""C"

        • qIsSemantic boolean

          If set to true, it means that the field is a semantic.

        • qNumFormat object

          Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

          Formatting mechanism

          The formatting mechanism depends on the type set in qType, as shown below:

          In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

          Type is DATE, TIME, TIMESTAMP or INTERVAL

          The following applies:

          • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
          • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
          • The properties qDec , qThou , qnDec , qUseThou are not used.

          Type is INTEGER

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

          Type is REAL

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
          • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
          • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is FIX

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is MONEY

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
          • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

          Type is ASCII

          No formatting, qFmt is ignored.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qIsAutoFormat boolean

          This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition.

        • qGroupFieldDefs array of strings

          Array of field names.

        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qContinuousAxes boolean

          Is continuous axis used.

        • qIsCyclic boolean

          Is a cyclic dimension used.

        • qDerivedField boolean

          Is derived field is used as a dimension.

        • qAttrExprInfo array of objects

          Array of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qIsAutoFormat boolean

            This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
        • qAttrDimInfo array of objects

          Array of attribute dimensions.

          Show qAttrDimInfo properties
          • qCardinal integer

            Cardinality of the attribute expression.

            format = int32

          • qSize object
            Show qSize properties
            • qcx integer

              Number of pixels on the x axis.

              format = int32

            • qcy integer

              Number of pixels on the y axis.

              format = int32

          • qFallbackTitle string

            The title for the attribute dimension.

          • qLocked boolean

            The Locked value of the dimension.

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qIsCalculated boolean

            True if this is a calculated dimension.

            default = false

        • qCalcCondMsg string

          The message displayed if calculation condition is not fulfilled.

        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

        • qIsOneAndOnlyOne boolean

          If set to true, it means that the field always has one and only one selected value.

        • qCardinalities object
          Show qCardinalities properties
          • qCardinal integer

            Number of distinct field values.

            format = int32

          • qHypercubeCardinal integer

            Number of distinct hypercube values.

            format = int32

          • qAllValuesCardinal integer

            Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

            default = -1, format = int32, default = -1

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qEffectiveDimensionName string
          Experimental

          The expanded and stripped dimension name used internally in engine.
      • qMeasureInfo array of objects

        Information on the measure.

        Show qMeasureInfo properties
        • qFallbackTitle string

          Corresponds to the label of the measure. If the label is not defined then the measure name is used.

        • qApprMaxGlyphCount integer

          Length of the longest value in the field.

          format = int32

        • qCardinal integer

          Number of distinct field values.

          format = int32

        • qSortIndicator string

          Can be one of: "N""A""D"

        • qNumFormat object

          Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

          Formatting mechanism

          The formatting mechanism depends on the type set in qType, as shown below:

          In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

          Type is DATE, TIME, TIMESTAMP or INTERVAL

          The following applies:

          • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
          • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
          • The properties qDec , qThou , qnDec , qUseThou are not used.

          Type is INTEGER

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

          Type is REAL

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
          • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
          • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is FIX

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is MONEY

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
          • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

          Type is ASCII

          No formatting, qFmt is ignored.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qMin number

          Lowest value in the range.

          format = double

        • qMax number

          Highest value in the range.

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qIsAutoFormat boolean

          This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.

        • qAttrExprInfo array of objects

          List of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qIsAutoFormat boolean

            This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
        • qAttrDimInfo array of objects

          List of attribute dimensions.

          Show qAttrDimInfo properties
          • qCardinal integer

            Cardinality of the attribute expression.

            format = int32

          • qSize object
            Show qSize properties
            • qcx integer

              Number of pixels on the x axis.

              format = int32

            • qcy integer

              Number of pixels on the y axis.

              format = int32

          • qFallbackTitle string

            The title for the attribute dimension.

          • qLocked boolean

            The Locked value of the dimension.

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qIsCalculated boolean

            True if this is a calculated dimension.

            default = false

        • qCalcCondMsg string

          The message displayed if calculation condition is not fulfilled.

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qTrendLines array of objects
          Experimental

          Calculated trendlines

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qCoeff array of numbers

            Coefficent c0..cN depending on the trendline type.

          • qR2 number

            R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

            format = double

          • qExpression string

            Trendline expression

          • qElemNo integer

            Inner Dim elem no

            format = int32

        • qMiniChart object
          Show qMiniChart properties
          • qYMin number

            format = double

          • qYMax number

            format = double

          • qXMin number

            format = double

          • qXMax number

            format = double

          • qAttrExprInfo array of objects

            List of attribute expressions.

            Show qAttrExprInfo properties
            • qMin number

              Minimum value.

              format = double

            • qMax number

              Maximum value.

              format = double

            • qFallbackTitle string
            • qMinText string

              String version of the minimum Value.

            • qMaxText string

              String version of the maximum Value.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qIsAutoFormat boolean

              This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
      • qEffectiveInterColumnSortOrder array of integers

        Sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted was the column 1, followed by the column 0 and the column 2.

      • qGrandTotalRow array of objects

        Aggregate for measures of all values in the field. The result value depends on the qAggrFunc defined in HyperCubeDef.

        Show qGrandTotalRow properties
        • qText string

          Some text. This parameter is optional.

        • qNum number

          A value. This parameter is optional.

          format = double

        • qElemNumber integer

          Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

          • -1: the cell is a Total cell. It shows a total.
          • -2: the cell is a Null cell.
          • -3: the cell belongs to the group Others .
          • -4: the cell is empty. Applies to pivot tables.

          format = int32

        • qState string

          Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

        • qIsEmpty boolean

          Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

        • qIsTotalCell boolean

          Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

        • qIsOtherCell boolean

          Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

        • qFrequency string

          Frequency of the value. This parameter is optional.

        • qHighlightRanges object
          Show qHighlightRanges properties
          • qRanges array of objects

            Ranges of highlighted values.

            Show qRanges properties
            • qCharPos integer

              Position of the first search occurrence.

              format = int32

            • qCharCount integer

              Number of occurrences found.

              format = int32

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

        • qIsNull boolean

          Is set to true if the value is Null.

        • qMiniChart object
          Show qMiniChart properties
          • qMatrix array of arrays

            Array of data.

            Show qMatrix properties
            • qText string

              Some text.

            • qNum number

              A value. This parameter is optional.

              format = double

            • qElemNumber integer

              Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

              • -1: the cell is a Total cell. It shows a total.
              • -2: the cell is a Null cell.
              • -3: the cell belongs to the group Others .
              • -4: the cell is empty. Applies to pivot tables.

              format = int32

            • qAttrExps object
              Show qAttrExps properties
              • qValues array of objects

                List of attribute expressions values.

                Show qValues properties
                • qText string

                  Text related to the attribute expression value.

                • qNum number

                  Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                  format = double

          • qMin number

            format = double

          • qMax number

            format = double

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
        • qInExtRow boolean
      • qDataPages array of objects

        Set of data. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

        Show qDataPages properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text. This parameter is optional.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qState string

            Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

          • qIsEmpty boolean

            Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

          • qIsTotalCell boolean

            Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

          • qIsOtherCell boolean

            Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

          • qFrequency string

            Frequency of the value. This parameter is optional.

          • qHighlightRanges object
            Show qHighlightRanges properties
            • qRanges array of objects

              Ranges of highlighted values.

              Show qRanges properties
              • qCharPos integer

                Position of the first search occurrence.

                format = int32

              • qCharCount integer

                Number of occurrences found.

                format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

          • qAttrDims object
            Show qAttrDims properties
            • qValues array of objects

              List of values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

              • qElemNo integer

                Element number.

                format = int32

          • qIsNull boolean

            Is set to true if the value is Null.

          • qMiniChart object
            Show qMiniChart properties
            • qMatrix array of arrays

              Array of data.

              Show qMatrix properties
              • qText string

                Some text.

              • qNum number

                A value. This parameter is optional.

                format = double

              • qElemNumber integer

                Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

                • -1: the cell is a Total cell. It shows a total.
                • -2: the cell is a Null cell.
                • -3: the cell belongs to the group Others .
                • -4: the cell is empty. Applies to pivot tables.

                format = int32

              • qAttrExps object
                Show qAttrExps properties
                • qValues array of objects

                  List of attribute expressions values.

                  Show qValues properties
                  • qText string

                    Text related to the attribute expression value.

                  • qNum number

                    Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                    format = double

            • qMin number

              format = double

            • qMax number

              format = double

            • qError object
              Show qError properties
              • qErrorCode integer

                Error code. This parameter is always displayed in case of error.

                format = int32

              • qContext string

                Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

              • qExtendedMessage string

                Internal information from the server. This parameter is optional.
          • qInExtRow boolean
        • qTails array of objects

          Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

          Show qTails properties
          • qUp integer

            Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

            format = int32

          • qDown integer

            Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

            format = int32

        • qArea object
          Show qArea properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qIsReduced boolean

          Is set to true, if the data have been reduced. The default value is false.

          default = false

      • qPivotDataPages array of objects

        Set of data for pivot tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

        Show qPivotDataPages properties
        • qLeft array of objects

          Information about the left dimension values of a pivot table.

          Show qLeft properties
          • qText string

            Some text.

          • qElemNo integer

            Rank number of the value. If set to -1, it means that the value is not an element number.

            format = int32

          • qValue number

            Value of the cell. Is set to NaN , if the value is not a number.

            format = double

          • qCanExpand boolean

            If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

          • qCanCollapse boolean

            If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

          • qType string

            Can be one of: "V""E""N""T""O""A""P""R""U""G"

          • qUp integer

            Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

            format = int32

          • qDown integer

            Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

            format = int32

          • qSubNodes array of undefineds

            Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

          • qAttrDims object
            Show qAttrDims properties
            • qValues array of objects

              List of values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

              • qElemNo integer

                Element number.

                format = int32

        • qTop array of objects

          Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.

          Show qTop properties
          • qText string

            Some text.

          • qElemNo integer

            Rank number of the value. If set to -1, it means that the value is not an element number.

            format = int32

          • qValue number

            Value of the cell. Is set to NaN , if the value is not a number.

            format = double

          • qCanExpand boolean

            If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

          • qCanCollapse boolean

            If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

          • qType string

            Can be one of: "V""E""N""T""O""A""P""R""U""G"

          • qUp integer

            Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

            format = int32

          • qDown integer

            Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .

            format = int32

          • qSubNodes array of undefineds

            Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

          • qAttrDims object
            Show qAttrDims properties
            • qValues array of objects

              List of values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

              • qElemNo integer

                Element number.

                format = int32

        • qData array of arrays

          Array of data.

          Show qData properties
          • qLabel string

            Label of the cell. This parameter is optional.

          • qText string

            Some text related to the cell.

          • qNum number

            Value of the cell.

            format = double

          • qType string

            Can be one of: "V""E""N""T""O""A""P""R""U""G"

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

          • qAttrDims object
            Show qAttrDims properties
            • qValues array of objects

              List of values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

              • qElemNo integer

                Element number.

                format = int32

        • qArea object
          Show qArea properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

      • qStackedDataPages array of objects

        Set of data for stacked tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

        Show qStackedDataPages properties
        • qData array of objects

          Array of data.

          Show qData properties
          • qText string

            Some text.

          • qElemNo integer

            Rank number of the value. If set to -1, it means that the value is not an element number.

            format = int32

          • qValue number

            Value of the cell. Is set to NaN , if the value is not a number.

            format = double

          • qCanExpand boolean

            If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

          • qCanCollapse boolean

            If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

          • qType string

            Can be one of: "V""E""N""T""O""A""P""R""U""G"

          • qMaxPos number

            Total of the positive values in the current group of cells.

            format = double

          • qMinNeg number

            Total of the negative values in the current group of cells.

            format = double

          • qUp integer

            Number of elements that are part of the previous tail.

            format = int32

          • qDown integer

            Number of elements that are part of the next tail.

            format = int32

          • qRow integer

            Row index in the data matrix. The indexing starts from 0.

            format = int32

          • qSubNodes array of undefineds

            Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

          • qAttrDims object
            Show qAttrDims properties
            • qValues array of objects

              List of values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

              • qElemNo integer

                Element number.

                format = int32

        • qArea object
          Show qArea properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

      • qMode string

        Can be one of: "S""P""K""T""D"

      • qNoOfLeftDims integer

        Number of left dimensions. Default value is -1. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category
        • One pseudo dimension in position 1
        • Three left dimensions.

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position -1.
        • Three left dimensions.

        implies that:

        • The index -1 corresponds to the pseudo dimension; the pseudo dimension is the most to the right.
        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.

        format = int32

      • qIndentMode boolean

        Is used for pivot tables only. If set to true, the formatting of the results is slightly different. This property is optional.

      • qLastExpandedPos object
        Show qLastExpandedPos properties
        • qx integer

          Position of the cell on the x-axis.

          format = int32

        • qy integer

          Position of the cell on the y-axis.

          format = int32

      • qHasOtherValues boolean

        True if other row exists.

      • qTitle string

        Title of the hypercube, for example the title of a chart.

      • qTreeNodesOnDim array of integers

        The total number of nodes on each dimension (only applicable when qMode = T ).

      • qCalcCondMsg string

        The message displayed if calculation condition is not fulfilled.

      • qColumnOrder array of integers

        The order of the columns.
    • qListObject object

      Renders the properties of a list object. Is the layout for ListObjectDef. For more information about the definition of a list object, see Generic object.

      ListObject is used by the _GetLayout Method_ to display the properties of a list object.
      Show qListObject properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qSize object
        Show qSize properties
        • qcx integer

          Number of pixels on the x axis.

          format = int32

        • qcy integer

          Number of pixels on the y axis.

          format = int32

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qDimensionInfo object
        Show qDimensionInfo properties
        • qFallbackTitle string

          Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used.

        • qApprMaxGlyphCount integer

          Length of the longest value in the field.

          format = int32

        • qCardinal integer Deprecated

          Number of distinct field values.

          format = int32

        • qLocked boolean

          Is set to true if the field is locked.

        • qSortIndicator string

          Can be one of: "N""A""D"

        • qGroupFallbackTitles array of strings

          Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group).

        • qGroupPos integer

          Index of the dimension that is currently in use. qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups.

          format = int32

        • qStateCounts object
          Show qStateCounts properties
          • qLocked integer

            Number of values in locked state.

            format = int32

          • qSelected integer

            Number of values in selected state.

            format = int32

          • qOption integer

            Number of values in optional state.

            format = int32

          • qDeselected integer

            Number of values in deselected state.

            format = int32

          • qAlternative integer

            Number of values in alternative state.

            format = int32

          • qExcluded integer

            Number of values in excluded state.

            format = int32

          • qSelectedExcluded integer

            Number of values in selected excluded state.

            format = int32

          • qLockedExcluded integer

            Number of values in locked excluded state.

            format = int32

        • qTags array of strings

          Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qDimensionType string

          Can be one of: "D""N""T"

        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qGrouping string

          Can be one of: "N""H""C"

        • qIsSemantic boolean

          If set to true, it means that the field is a semantic.

        • qNumFormat object

          Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

          Formatting mechanism

          The formatting mechanism depends on the type set in qType, as shown below:

          In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

          Type is DATE, TIME, TIMESTAMP or INTERVAL

          The following applies:

          • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
          • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
          • The properties qDec , qThou , qnDec , qUseThou are not used.

          Type is INTEGER

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

          Type is REAL

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
          • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
          • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is FIX

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is MONEY

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
          • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

          Type is ASCII

          No formatting, qFmt is ignored.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qIsAutoFormat boolean

          This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition.

        • qGroupFieldDefs array of strings

          Array of field names.

        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qContinuousAxes boolean

          Is continuous axis used.

        • qIsCyclic boolean

          Is a cyclic dimension used.

        • qDerivedField boolean

          Is derived field is used as a dimension.

        • qAttrExprInfo array of objects

          Array of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qIsAutoFormat boolean

            This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
        • qAttrDimInfo array of objects

          Array of attribute dimensions.

          Show qAttrDimInfo properties
          • qCardinal integer

            Cardinality of the attribute expression.

            format = int32

          • qSize object
            Show qSize properties
            • qcx integer

              Number of pixels on the x axis.

              format = int32

            • qcy integer

              Number of pixels on the y axis.

              format = int32

          • qFallbackTitle string

            The title for the attribute dimension.

          • qLocked boolean

            The Locked value of the dimension.

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qIsCalculated boolean

            True if this is a calculated dimension.

            default = false

        • qCalcCondMsg string

          The message displayed if calculation condition is not fulfilled.

        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

        • qIsOneAndOnlyOne boolean

          If set to true, it means that the field always has one and only one selected value.

        • qCardinalities object
          Show qCardinalities properties
          • qCardinal integer

            Number of distinct field values.

            format = int32

          • qHypercubeCardinal integer

            Number of distinct hypercube values.

            format = int32

          • qAllValuesCardinal integer

            Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

            default = -1, format = int32, default = -1

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qEffectiveDimensionName string
          Experimental

          The expanded and stripped dimension name used internally in engine.
      • qExpressions array of objects

        Lists the expressions in the list object.

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code.

            format = int32

      • qDataPages array of objects

        Set of data. Is empty if nothing has been defined in qInitialDataFetch in ListObjectDef.

        Show qDataPages properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text. This parameter is optional.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qState string

            Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

          • qIsEmpty boolean

            Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

          • qIsTotalCell boolean

            Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

          • qIsOtherCell boolean

            Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

          • qFrequency string

            Frequency of the value. This parameter is optional.

          • qHighlightRanges object
            Show qHighlightRanges properties
            • qRanges array of objects

              Ranges of highlighted values.

              Show qRanges properties
              • qCharPos integer

                Position of the first search occurrence.

                format = int32

              • qCharCount integer

                Number of occurrences found.

                format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

          • qAttrDims object
            Show qAttrDims properties
            • qValues array of objects

              List of values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

              • qElemNo integer

                Element number.

                format = int32

          • qIsNull boolean

            Is set to true if the value is Null.

          • qMiniChart object
            Show qMiniChart properties
            • qMatrix array of arrays

              Array of data.

              Show qMatrix properties
              • qText string

                Some text.

              • qNum number

                A value. This parameter is optional.

                format = double

              • qElemNumber integer

                Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

                • -1: the cell is a Total cell. It shows a total.
                • -2: the cell is a Null cell.
                • -3: the cell belongs to the group Others .
                • -4: the cell is empty. Applies to pivot tables.

                format = int32

              • qAttrExps object
                Show qAttrExps properties
                • qValues array of objects

                  List of attribute expressions values.

                  Show qValues properties
                  • qText string

                    Text related to the attribute expression value.

                  • qNum number

                    Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                    format = double

            • qMin number

              format = double

            • qMax number

              format = double

            • qError object
              Show qError properties
              • qErrorCode integer

                Error code. This parameter is always displayed in case of error.

                format = int32

              • qContext string

                Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

              • qExtendedMessage string

                Internal information from the server. This parameter is optional.
          • qInExtRow boolean
        • qTails array of objects

          Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

          Show qTails properties
          • qUp integer

            Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

            format = int32

          • qDown integer

            Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

            format = int32

        • qArea object
          Show qArea properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qIsReduced boolean

          Is set to true, if the data have been reduced. The default value is false.

          default = false

    • qMeasureList object

      Lists the measures. Is the layout for MeasureListDef.

      Show qMeasureList properties
      • qItems array of objects

        Information about the list of measures.

        Show qItems properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qMeta object

          Layout for NxMetaDef.

          Show qMeta properties
          • qName string

            Name. This property is optional.
        • qData object

          Contains dynamic JSON data specified by the client.
    • qMediaList object

      Lists the media files. Is the layout for MediaListDef.

      This struct is deprecated.
      Show qMediaList properties
      • qItems array of objects

        Information about the list of media files. In Qlik Sense Desktop, the media files are retrieved from: %userprofile%\Documents\Qlik\Sense\Content\Default In Qlik Sense Enterprise, the media files are retrieved from: <installation_directory>\Qlik\Sense\Repository\Content\Default The default installation directory is ProgramData .

        Show qItems properties
        • qUrlDef string

          Relative path to the media file. The URL is static. Media files located:

          • in the /content/default/ folder are outside the qvf file.
          • in the /media/ folder are embedded in the qvf file.
        • qUrl string

          Relative path to the media file. Media files located:

          • in the /content/default/ folder are outside the qvf file.
          • in the /media/ folder are embedded in the qvf file.
    • qNxLibraryDimension object
      Show qNxLibraryDimension properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated
      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasure object

      Information about the library measure. Is the layout for NxLibraryMeasureDef.

      Show qNxLibraryMeasure properties
      • qLabel string
      • qDef string
      • qGrouping string

        Can be one of: "N""H""C"

      • qExpressions array of strings
      • qActiveExpression integer

        format = int32

      • qLabelExpression string
      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated
      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObject object

      Indicates which selections are currently applied. It gives the current selections. Is the layout for SelectionObjectDef.

      Show qSelectionObject properties
      • qBackCount integer

        Number of steps back.

        format = int32

      • qForwardCount integer

        Number of steps forward.

        format = int32

      • qSelections array of objects

        Lists the fields that are selected.

        Show qSelections properties
        • qTotal integer

          Number of values in the field.

          format = int32

        • qIsNum boolean

          This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional.

        • qField string

          Name of the field that is selected.

        • qLocked boolean

          This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional.

        • qOneAndOnlyOne boolean

          This parameter is displayed if its value is true. Property that is set to a field. Is set to true if the field cannot be unselected. This parameter is optional.

        • qTextSearch string

          Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional.

        • qSelectedCount integer

          Number of values that are selected.

          format = int32

        • qSelected string

          Values that are selected.

        • qRangeInfo array of objects

          Information about the range of selected values. Is empty if there is no range of selected values.

          Show qRangeInfo properties
          • qRangeLo number

            Lowest value in the range.

            default = -1e+300, format = double, default = -1e+300

          • qRangeHi number

            Highest value in the range.

            default = -1e+300, format = double, default = -1e+300

          • qMeasure string

            Label of the measure.
        • qSortIndex integer

          Sort index of the field. Indexing starts from 0.

          format = int32

        • qStateCounts object
          Show qStateCounts properties
          • qLocked integer

            Number of values in locked state.

            format = int32

          • qSelected integer

            Number of values in selected state.

            format = int32

          • qOption integer

            Number of values in optional state.

            format = int32

          • qDeselected integer

            Number of values in deselected state.

            format = int32

          • qAlternative integer

            Number of values in alternative state.

            format = int32

          • qExcluded integer

            Number of values in excluded state.

            format = int32

          • qSelectedExcluded integer

            Number of values in selected excluded state.

            format = int32

          • qLockedExcluded integer

            Number of values in locked excluded state.

            format = int32

        • qSelectedFieldSelectionInfo array of objects

          Information about the fields that are selected.

          Show qSelectedFieldSelectionInfo properties
          • qName string

            Name of the field.

          • qFieldSelectionMode string

            Can be one of: "NORMAL""AND""NOT"

        • qNotSelectedFieldSelectionInfo array of objects

          Information about the fields that are not selected.

          Show qNotSelectedFieldSelectionInfo properties
          • qName string

            Name of the field.

          • qFieldSelectionMode string

            Can be one of: "NORMAL""AND""NOT"

        • qSelectionThreshold integer

          Maximum values to show in the current selections. The default value is 6.

          format = int32

        • qReadableName string

          Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly.

        • qIsHidden boolean

          Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden.

        • qDimensionReferences array of objects
          Experimental

          List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem.

          Show qDimensionReferences properties
          • qId string

            Identifier of the associated dimension.

          • qLabel string

            Text label.
      • qStateName string

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrl object
      In addition, this structure can return dynamic properties.
      Show qStaticContentUrl properties
      • qUrl string

        Relative path of the thumbnail.
    • qTreeData object

      Renders the properties of a TreeData object. Is the layout for TreeDataDef. For more information about the definition of TreeData, see Generic object.

      To retrieve data from the TreeData object, use the method called GetHyperCubeTreeData.
      Show qTreeData properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qNodesOnDim array of integers

        The total number of nodes on each dimension.

      • qError object
        Show qError properties
        • qErrorCode integer

          Error code. This parameter is always displayed in case of error.

          format = int32

        • qContext string

          Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

        • qExtendedMessage string

          Internal information from the server. This parameter is optional.
      • qDimensionInfo array of objects

        Information on the dimension.

        Show qDimensionInfo properties
        • qFallbackTitle string

          Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used.

        • qApprMaxGlyphCount integer

          Length of the longest value in the field.

          format = int32

        • qCardinal integer Deprecated

          Number of distinct field values.

          format = int32

        • qLocked boolean

          Is set to true if the field is locked.

        • qSortIndicator string

          Can be one of: "N""A""D"

        • qGroupFallbackTitles array of strings

          Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group).

        • qGroupPos integer

          Index of the dimension that is currently in use. qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups.

          format = int32

        • qStateCounts object
          Show qStateCounts properties
          • qLocked integer

            Number of values in locked state.

            format = int32

          • qSelected integer

            Number of values in selected state.

            format = int32

          • qOption integer

            Number of values in optional state.

            format = int32

          • qDeselected integer

            Number of values in deselected state.

            format = int32

          • qAlternative integer

            Number of values in alternative state.

            format = int32

          • qExcluded integer

            Number of values in excluded state.

            format = int32

          • qSelectedExcluded integer

            Number of values in selected excluded state.

            format = int32

          • qLockedExcluded integer

            Number of values in locked excluded state.

            format = int32

        • qTags array of strings

          Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qDimensionType string

          Can be one of: "D""N""T"

        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qGrouping string

          Can be one of: "N""H""C"

        • qIsSemantic boolean

          If set to true, it means that the field is a semantic.

        • qNumFormat object

          Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

          Formatting mechanism

          The formatting mechanism depends on the type set in qType, as shown below:

          In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

          Type is DATE, TIME, TIMESTAMP or INTERVAL

          The following applies:

          • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
          • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
          • The properties qDec , qThou , qnDec , qUseThou are not used.

          Type is INTEGER

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

          Type is REAL

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
          • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
          • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is FIX

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is MONEY

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
          • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

          Type is ASCII

          No formatting, qFmt is ignored.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qIsAutoFormat boolean

          This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition.

        • qGroupFieldDefs array of strings

          Array of field names.

        • qMin number

          Minimum value.

          format = double

        • qMax number

          Maximum value.

          format = double

        • qContinuousAxes boolean

          Is continuous axis used.

        • qIsCyclic boolean

          Is a cyclic dimension used.

        • qDerivedField boolean

          Is derived field is used as a dimension.

        • qMeasureInfo array of objects

          A List of measures to be calculated on this TreeDimension.

          Show qMeasureInfo properties
          • qFallbackTitle string

            Corresponds to the label of the measure. If the label is not defined then the measure name is used.

          • qApprMaxGlyphCount integer

            Length of the longest value in the field.

            format = int32

          • qCardinal integer

            Number of distinct field values.

            format = int32

          • qSortIndicator string

            Can be one of: "N""A""D"

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qMin number

            Lowest value in the range.

            format = double

          • qMax number

            Highest value in the range.

            format = double

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qIsAutoFormat boolean

            This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.

          • qAttrExprInfo array of objects

            List of attribute expressions.

            Show qAttrExprInfo properties
            • qMin number

              Minimum value.

              format = double

            • qMax number

              Maximum value.

              format = double

            • qFallbackTitle string
            • qMinText string

              String version of the minimum Value.

            • qMaxText string

              String version of the maximum Value.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qIsAutoFormat boolean

              This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
          • qAttrDimInfo array of objects

            List of attribute dimensions.

            Show qAttrDimInfo properties
            • qCardinal integer

              Cardinality of the attribute expression.

              format = int32

            • qSize object
              Show qSize properties
              • qcx integer

                Number of pixels on the x axis.

                format = int32

              • qcy integer

                Number of pixels on the y axis.

                format = int32

            • qFallbackTitle string

              The title for the attribute dimension.

            • qLocked boolean

              The Locked value of the dimension.

            • qError object
              Show qError properties
              • qErrorCode integer

                Error code. This parameter is always displayed in case of error.

                format = int32

              • qContext string

                Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

              • qExtendedMessage string

                Internal information from the server. This parameter is optional.
            • qIsCalculated boolean

              True if this is a calculated dimension.

              default = false

          • qCalcCondMsg string

            The message displayed if calculation condition is not fulfilled.

          • qLibraryId string

            Refers to a dimension stored in the library.

          • qTrendLines array of objects
            Experimental

            Calculated trendlines

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qError object
              Show qError properties
              • qErrorCode integer

                Error code. This parameter is always displayed in case of error.

                format = int32

              • qContext string

                Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

              • qExtendedMessage string

                Internal information from the server. This parameter is optional.
            • qCoeff array of numbers

              Coefficent c0..cN depending on the trendline type.

            • qR2 number

              R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

              format = double

            • qExpression string

              Trendline expression

            • qElemNo integer

              Inner Dim elem no

              format = int32

          • qMiniChart object
            Show qMiniChart properties
            • qYMin number

              format = double

            • qYMax number

              format = double

            • qXMin number

              format = double

            • qXMax number

              format = double

            • qAttrExprInfo array of objects

              List of attribute expressions.

              Show qAttrExprInfo properties
              • qMin number

                Minimum value.

                format = double

              • qMax number

                Maximum value.

                format = double

              • qFallbackTitle string
              • qMinText string

                String version of the minimum Value.

              • qMaxText string

                String version of the maximum Value.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qIsAutoFormat boolean

                This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
            • qError object
              Show qError properties
              • qErrorCode integer

                Error code. This parameter is always displayed in case of error.

                format = int32

              • qContext string

                Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

              • qExtendedMessage string

                Internal information from the server. This parameter is optional.
        • qAttrExprInfo array of objects

          List of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qIsAutoFormat boolean

            This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
        • qAttrDimInfo array of objects

          List of attribute dimensions.

          Show qAttrDimInfo properties
          • qCardinal integer

            Cardinality of the attribute expression.

            format = int32

          • qSize object
            Show qSize properties
            • qcx integer

              Number of pixels on the x axis.

              format = int32

            • qcy integer

              Number of pixels on the y axis.

              format = int32

          • qFallbackTitle string

            The title for the attribute dimension.

          • qLocked boolean

            The Locked value of the dimension.

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qIsCalculated boolean

            True if this is a calculated dimension.

            default = false

        • qCalcCondMsg string

          The message displayed if calculation condition is not fulfilled.

        • qIsCalculated boolean

          True if this is a calculated dimension.

          default = false

        • qIsOneAndOnlyOne boolean

          If set to true, it means that the field always has one and only one selected value.

        • qCardinalities object
          Show qCardinalities properties
          • qCardinal integer

            Number of distinct field values.

            format = int32

          • qHypercubeCardinal integer

            Number of distinct hypercube values.

            format = int32

          • qAllValuesCardinal integer

            Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

            default = -1, format = int32, default = -1

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qEffectiveDimensionName string
          Experimental

          The expanded and stripped dimension name used internally in engine.
      • qEffectiveInterColumnSortOrder array of integers

        Defines the order of the dimenion levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2.

      • qHasOtherValues boolean

        True if other row exists.

      • qTitle string

        Title of the TreeData object, for example the title of a chart.

      • qLastExpandedPos object
        Show qLastExpandedPos properties
        • qx integer

          Position of the cell on the x-axis.

          format = int32

        • qy integer

          Position of the cell on the y-axis.

          format = int32

      • qCalcCondMsg string

        The message displayed if calculation condition is not fulfilled.

      • qTreeDataPages array of objects

        Set of data. Is empty if nothing has been defined in qInitialDataFetch in TreeDataDef.

        Show qTreeDataPages properties
        • qText string

          The text version of the value, if available.

        • qValue number

          Value of the cell. Is set to NaN , if the value is not a number.

          format = double

        • qElemNo integer

          Element number.

          format = int32

        • qGroupPos integer

          The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.

          format = int32

        • qGroupSize integer

          Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.

          format = int32

        • qRow integer

          Row index in the data matrix. The indexing starts from 0.

          format = int32

        • qType string

          Can be one of: "V""E""N""T""O""A""P""R""U""G"

        • qValues array of objects

          The measures for this node.

          Show qValues properties
          • qText string

            The text version of the value, if available.

          • qValue number

            Value of the cell. Is set to NaN , if the value is not a number.

            format = double

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

          • qAttrDims object
            Show qAttrDims properties
            • qValues array of objects

              List of values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

              • qElemNo integer

                Element number.

                format = int32

        • qNodes array of undefineds

          The children of this node in the fetched tree structure.

        • qAttrExps object
          Show qAttrExps properties
          • qValues array of objects

            List of attribute expressions values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value.

            • qNum number

              Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

              format = double

        • qAttrDims object
          Show qAttrDims properties
          • qValues array of objects

            List of values.

            Show qValues properties
            • qText string

              Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

            • qElemNo integer

              Element number.

              format = int32

        • qMaxPos array of numbers

          Total of the positive values in the current group of cells.

        • qMinNeg array of numbers

          Total of the negative values in the current group of cells.

        • qCanExpand boolean

          If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.

        • qCanCollapse boolean

          If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.

        • qState string

          Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

        • qTreePath array of integers

          The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.
      • qMeasureInfo array of objects

        Information on the measures calculated on the whole tree.

        Show qMeasureInfo properties
        • qFallbackTitle string

          Corresponds to the label of the measure. If the label is not defined then the measure name is used.

        • qApprMaxGlyphCount integer

          Length of the longest value in the field.

          format = int32

        • qCardinal integer

          Number of distinct field values.

          format = int32

        • qSortIndicator string

          Can be one of: "N""A""D"

        • qNumFormat object

          Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

          Formatting mechanism

          The formatting mechanism depends on the type set in qType, as shown below:

          In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

          Type is DATE, TIME, TIMESTAMP or INTERVAL

          The following applies:

          • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
          • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
          • The properties qDec , qThou , qnDec , qUseThou are not used.

          Type is INTEGER

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

          Type is REAL

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
          • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
          • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is FIX

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is MONEY

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
          • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

          Type is ASCII

          No formatting, qFmt is ignored.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qMin number

          Lowest value in the range.

          format = double

        • qMax number

          Highest value in the range.

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qIsAutoFormat boolean

          This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.

        • qAttrExprInfo array of objects

          List of attribute expressions.

          Show qAttrExprInfo properties
          • qMin number

            Minimum value.

            format = double

          • qMax number

            Maximum value.

            format = double

          • qFallbackTitle string
          • qMinText string

            String version of the minimum Value.

          • qMaxText string

            String version of the maximum Value.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qIsAutoFormat boolean

            This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
        • qAttrDimInfo array of objects

          List of attribute dimensions.

          Show qAttrDimInfo properties
          • qCardinal integer

            Cardinality of the attribute expression.

            format = int32

          • qSize object
            Show qSize properties
            • qcx integer

              Number of pixels on the x axis.

              format = int32

            • qcy integer

              Number of pixels on the y axis.

              format = int32

          • qFallbackTitle string

            The title for the attribute dimension.

          • qLocked boolean

            The Locked value of the dimension.

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qIsCalculated boolean

            True if this is a calculated dimension.

            default = false

        • qCalcCondMsg string

          The message displayed if calculation condition is not fulfilled.

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qTrendLines array of objects
          Experimental

          Calculated trendlines

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
          • qCoeff array of numbers

            Coefficent c0..cN depending on the trendline type.

          • qR2 number

            R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.

            format = double

          • qExpression string

            Trendline expression

          • qElemNo integer

            Inner Dim elem no

            format = int32

        • qMiniChart object
          Show qMiniChart properties
          • qYMin number

            format = double

          • qYMax number

            format = double

          • qXMin number

            format = double

          • qXMax number

            format = double

          • qAttrExprInfo array of objects

            List of attribute expressions.

            Show qAttrExprInfo properties
            • qMin number

              Minimum value.

              format = double

            • qMax number

              Maximum value.

              format = double

            • qFallbackTitle string
            • qMinText string

              String version of the minimum Value.

            • qMaxText string

              String version of the maximum Value.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qIsAutoFormat boolean

              This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
          • qError object
            Show qError properties
            • qErrorCode integer

              Error code. This parameter is always displayed in case of error.

              format = int32

            • qContext string

              Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

            • qExtendedMessage string

              Internal information from the server. This parameter is optional.
    • qUndoInfo object

      Displays information about the number of possible undos and redos. Is the layout for UndoInfoDef.

      Show qUndoInfo properties
      • qUndoCount integer

        Number of possible undos.

        format = int32

      • qRedoCount integer

        Number of possible redos.

        format = int32

    • qVariableList object

      Lists the variables in an app. Is the layout for VariableListDef.

      Show qVariableList properties
      • qItems array of objects

        List of the variables.

        Show qItems properties
        • qName string

          Name of the variable.

        • qDescription string

          Description of the variable.

        • qDefinition string

          Definition of the variable. It can be a value or an expression.

        • qIsConfig boolean

          If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false.

          default = false

        • qIsReserved boolean

          If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples:

          • ScriptError is a reserved variable, set by the engine.
          • DayNames is a reserved variable, set by the user.

          default = false

        • qMeta object

          Layout for NxMetaDef.

          Show qMeta properties
          • qName string

            Name. This property is optional.
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qData object

          Contains dynamic JSON data specified by the client.

        • qIsScriptCreated boolean

          If set to true, it means that the variable was defined via script.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object

Errors

array
GenericErrors

GetLayout()

enigma.js
const result = await genericObject.getLayout()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetLayout"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qLayout": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qMeta": {
        "qName": "value"
      },
      "qExtendsId": "value",
      "qHasSoftPatches": true,
      "qError": {
        "qErrorCode": 123
      },
      "qSelectionInfo": {
        "qInSelections": true,
        "qMadeSelections": true
      },
      "qStateName": "value",
      "qAppObjectList": {
        "qItems": [
          {
            "qInfo": {
              "qId": "value",
              "qType": "value"
            },
            "qMeta": {
              "qName": "value"
            },
            "qData": {}
          }
        ]
      },
      "qBookmarkList": {
        "qItems": [
          {
            "qInfo": {
              "qId": "value",
              "qType": "value"
            },
            "qMeta": {
              "qName": "value"
            },
            "qData": {}
          }
        ]
      },
      "qChildList": {
        "qItems": [
          {
            "qInfo": {
              "qId": "value",
              "qType": "value"
            },
            "qMeta": {
              "qName": "value"
            },
            "qData": {}
          }
        ]
      },
      "qDimensionList": {
        "qItems": [
          {
            "qInfo": {
              "qId": "value",
              "qType": "value"
            },
            "qMeta": {
              "qName": "value"
            },
            "qData": {}
          }
        ]
      },
      "qEmbeddedSnapshot": {},
      "qExtensionList": {
        "qItems": [
          "value"
        ]
      },
      "qFieldList": {
        "qItems": [
          {
            "qIsSemantic": true,
            "qIsHidden": true,
            "qIsSystem": true,
            "qAndMode": true,
            "qName": "value",
            "qCardinal": 123,
            "qTags": [
              "value"
            ],
            "qIsDefinitionOnly": true,
            "qDerivedFieldData": {
              "qDerivedFieldLists": [
                {
                  "qDerivedDefinitionName": "value",
                  "qFieldDefs": [
                    {
                      "qId": "value",
                      "qName": "value",
                      "qMethod": "value",
                      "qExpr": "value",
                      "qTags": [
                        "value"
                      ]
                    }
                  ],
                  "qGroupDefs": [
                    {
                      "qId": "value",
                      "qName": "value",
                      "qGrouping": "N",
                      "qFieldDefs": [
                        "value"
                      ]
                    }
                  ],
                  "qTags": [
                    "value"
                  ]
                }
              ]
            },
            "qIsDetail": true,
            "qIsImplicit": true,
            "qReadableName": "value"
          }
        ]
      },
      "qHyperCube": {
        "qStateName": "value",
        "qSize": {
          "qcx": 123,
          "qcy": 123
        },
        "qError": {
          "qErrorCode": 123,
          "qContext": "value",
          "qExtendedMessage": "value"
        },
        "qDimensionInfo": [
          {
            "qFallbackTitle": "value",
            "qApprMaxGlyphCount": 123,
            "qCardinal": 123,
            "qLocked": true,
            "qSortIndicator": "N",
            "qGroupFallbackTitles": [
              "value"
            ],
            "qGroupPos": 123,
            "qStateCounts": {
              "qLocked": 123,
              "qSelected": 123,
              "qOption": 123,
              "qDeselected": 123,
              "qAlternative": 123,
              "qExcluded": 123,
              "qSelectedExcluded": 123,
              "qLockedExcluded": 123
            },
            "qTags": [
              "value"
            ],
            "qError": {
              "qErrorCode": 123,
              "qContext": "value",
              "qExtendedMessage": "value"
            },
            "qDimensionType": "D",
            "qReverseSort": true,
            "qGrouping": "N",
            "qIsSemantic": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qIsAutoFormat": true,
            "qGroupFieldDefs": [
              "value"
            ],
            "qMin": 123,
            "qMax": 123,
            "qContinuousAxes": true,
            "qIsCyclic": true,
            "qDerivedField": true,
            "qAttrExprInfo": [
              {
                "qMin": 123,
                "qMax": 123,
                "qFallbackTitle": "value",
                "qMinText": "value",
                "qMaxText": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qIsAutoFormat": true
              }
            ],
            "qAttrDimInfo": [
              {
                "qCardinal": 123,
                "qSize": {
                  "qcx": 123,
                  "qcy": 123
                },
                "qFallbackTitle": "value",
                "qLocked": true,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                },
                "qIsCalculated": false
              }
            ],
            "qCalcCondMsg": "value",
            "qIsCalculated": false,
            "qIsOneAndOnlyOne": true,
            "qCardinalities": {
              "qCardinal": 123,
              "qHypercubeCardinal": 123,
              "qAllValuesCardinal": -1
            },
            "qLibraryId": "value",
            "qEffectiveDimensionName": "value"
          }
        ],
        "qMeasureInfo": [
          {
            "qFallbackTitle": "value",
            "qApprMaxGlyphCount": 123,
            "qCardinal": 123,
            "qSortIndicator": "N",
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qMin": 123,
            "qMax": 123,
            "qError": {
              "qErrorCode": 123,
              "qContext": "value",
              "qExtendedMessage": "value"
            },
            "qReverseSort": true,
            "qIsAutoFormat": true,
            "qAttrExprInfo": [
              {
                "qMin": 123,
                "qMax": 123,
                "qFallbackTitle": "value",
                "qMinText": "value",
                "qMaxText": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qIsAutoFormat": true
              }
            ],
            "qAttrDimInfo": [
              {
                "qCardinal": 123,
                "qSize": {
                  "qcx": 123,
                  "qcy": 123
                },
                "qFallbackTitle": "value",
                "qLocked": true,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                },
                "qIsCalculated": false
              }
            ],
            "qCalcCondMsg": "value",
            "qLibraryId": "value",
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                },
                "qCoeff": [
                  123
                ],
                "qR2": 123,
                "qExpression": "value",
                "qElemNo": 123
              }
            ],
            "qMiniChart": {
              "qYMin": 123,
              "qYMax": 123,
              "qXMin": 123,
              "qXMax": 123,
              "qAttrExprInfo": [
                {
                  "qMin": 123,
                  "qMax": 123,
                  "qFallbackTitle": "value",
                  "qMinText": "value",
                  "qMaxText": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qIsAutoFormat": true
                }
              ],
              "qError": {
                "qErrorCode": 123,
                "qContext": "value",
                "qExtendedMessage": "value"
              }
            }
          }
        ],
        "qEffectiveInterColumnSortOrder": [
          123
        ],
        "qGrandTotalRow": [
          {
            "qText": "value",
            "qNum": 123,
            "qElemNumber": 123,
            "qState": "L",
            "qIsEmpty": true,
            "qIsTotalCell": true,
            "qIsOtherCell": true,
            "qFrequency": "value",
            "qHighlightRanges": {
              "qRanges": [
                {
                  "qCharPos": 123,
                  "qCharCount": 123
                }
              ]
            },
            "qAttrExps": {
              "qValues": [
                {
                  "qText": "value",
                  "qNum": 123
                }
              ]
            },
            "qAttrDims": {
              "qValues": [
                {
                  "qText": "value",
                  "qElemNo": 123
                }
              ]
            },
            "qIsNull": true,
            "qMiniChart": {
              "qMatrix": [
                [
                  {
                    "qText": "value",
                    "qNum": 123,
                    "qElemNumber": 123,
                    "qAttrExps": {
                      "qValues": [
                        {
                          "qText": "value",
                          "qNum": 123
                        }
                      ]
                    }
                  }
                ]
              ],
              "qMin": 123,
              "qMax": 123,
              "qError": {
                "qErrorCode": 123,
                "qContext": "value",
                "qExtendedMessage": "value"
              }
            },
            "qInExtRow": true
          }
        ],
        "qDataPages": [
          {
            "qMatrix": [
              [
                {
                  "qText": "value",
                  "qNum": 123,
                  "qElemNumber": 123,
                  "qState": "L",
                  "qIsEmpty": true,
                  "qIsTotalCell": true,
                  "qIsOtherCell": true,
                  "qFrequency": "value",
                  "qHighlightRanges": {
                    "qRanges": [
                      {
                        "qCharPos": 123,
                        "qCharCount": 123
                      }
                    ]
                  },
                  "qAttrExps": {
                    "qValues": [
                      {
                        "qText": "value",
                        "qNum": 123
                      }
                    ]
                  },
                  "qAttrDims": {
                    "qValues": [
                      {
                        "qText": "value",
                        "qElemNo": 123
                      }
                    ]
                  },
                  "qIsNull": true,
                  "qMiniChart": {
                    "qMatrix": [
                      [
                        {
                          "qText": "value",
                          "qNum": 123,
                          "qElemNumber": 123,
                          "qAttrExps": {
                            "qValues": [
                              {
                                "qText": "value",
                                "qNum": 123
                              }
                            ]
                          }
                        }
                      ]
                    ],
                    "qMin": 123,
                    "qMax": 123,
                    "qError": {
                      "qErrorCode": 123,
                      "qContext": "value",
                      "qExtendedMessage": "value"
                    }
                  },
                  "qInExtRow": true
                }
              ]
            ],
            "qTails": [
              {
                "qUp": 123,
                "qDown": 123
              }
            ],
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            },
            "qIsReduced": false
          }
        ],
        "qPivotDataPages": [
          {
            "qLeft": [
              {
                "qText": "value",
                "qElemNo": 123,
                "qValue": 123,
                "qCanExpand": true,
                "qCanCollapse": true,
                "qType": "V",
                "qUp": 123,
                "qDown": 123,
                "qSubNodes": [],
                "qAttrExps": {
                  "qValues": [
                    {
                      "qText": "value",
                      "qNum": 123
                    }
                  ]
                },
                "qAttrDims": {
                  "qValues": [
                    {
                      "qText": "value",
                      "qElemNo": 123
                    }
                  ]
                }
              }
            ],
            "qTop": [
              {
                "qText": "value",
                "qElemNo": 123,
                "qValue": 123,
                "qCanExpand": true,
                "qCanCollapse": true,
                "qType": "V",
                "qUp": 123,
                "qDown": 123,
                "qSubNodes": [],
                "qAttrExps": {
                  "qValues": [
                    {
                      "qText": "value",
                      "qNum": 123
                    }
                  ]
                },
                "qAttrDims": {
                  "qValues": [
                    {
                      "qText": "value",
                      "qElemNo": 123
                    }
                  ]
                }
              }
            ],
            "qData": [
              [
                {
                  "qLabel": "value",
                  "qText": "value",
                  "qNum": 123,
                  "qType": "V",
                  "qAttrExps": {
                    "qValues": [
                      {
                        "qText": "value",
                        "qNum": 123
                      }
                    ]
                  },
                  "qAttrDims": {
                    "qValues": [
                      {
                        "qText": "value",
                        "qElemNo": 123
                      }
                    ]
                  }
                }
              ]
            ],
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            }
          }
        ],
        "qStackedDataPages": [
          {
            "qData": [
              {
                "qText": "value",
                "qElemNo": 123,
                "qValue": 123,
                "qCanExpand": true,
                "qCanCollapse": true,
                "qType": "V",
                "qMaxPos": 123,
                "qMinNeg": 123,
                "qUp": 123,
                "qDown": 123,
                "qRow": 123,
                "qSubNodes": [],
                "qAttrExps": {
                  "qValues": [
                    {
                      "qText": "value",
                      "qNum": 123
                    }
                  ]
                },
                "qAttrDims": {
                  "qValues": [
                    {
                      "qText": "value",
                      "qElemNo": 123
                    }
                  ]
                }
              }
            ],
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            }
          }
        ],
        "qMode": "S",
        "qNoOfLeftDims": 123,
        "qIndentMode": true,
        "qLastExpandedPos": {
          "qx": 123,
          "qy": 123
        },
        "qHasOtherValues": true,
        "qTitle": "value",
        "qTreeNodesOnDim": [
          123
        ],
        "qCalcCondMsg": "value",
        "qColumnOrder": [
          123
        ]
      },
      "qListObject": {
        "qStateName": "value",
        "qSize": {
          "qcx": 123,
          "qcy": 123
        },
        "qError": {
          "qErrorCode": 123,
          "qContext": "value",
          "qExtendedMessage": "value"
        },
        "qDimensionInfo": {
          "qFallbackTitle": "value",
          "qApprMaxGlyphCount": 123,
          "qCardinal": 123,
          "qLocked": true,
          "qSortIndicator": "N",
          "qGroupFallbackTitles": [
            "value"
          ],
          "qGroupPos": 123,
          "qStateCounts": {
            "qLocked": 123,
            "qSelected": 123,
            "qOption": 123,
            "qDeselected": 123,
            "qAlternative": 123,
            "qExcluded": 123,
            "qSelectedExcluded": 123,
            "qLockedExcluded": 123
          },
          "qTags": [
            "value"
          ],
          "qError": {
            "qErrorCode": 123,
            "qContext": "value",
            "qExtendedMessage": "value"
          },
          "qDimensionType": "D",
          "qReverseSort": true,
          "qGrouping": "N",
          "qIsSemantic": true,
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qIsAutoFormat": true,
          "qGroupFieldDefs": [
            "value"
          ],
          "qMin": 123,
          "qMax": 123,
          "qContinuousAxes": true,
          "qIsCyclic": true,
          "qDerivedField": true,
          "qAttrExprInfo": [
            {
              "qMin": 123,
              "qMax": 123,
              "qFallbackTitle": "value",
              "qMinText": "value",
              "qMaxText": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qIsAutoFormat": true
            }
          ],
          "qAttrDimInfo": [
            {
              "qCardinal": 123,
              "qSize": {
                "qcx": 123,
                "qcy": 123
              },
              "qFallbackTitle": "value",
              "qLocked": true,
              "qError": {
                "qErrorCode": 123,
                "qContext": "value",
                "qExtendedMessage": "value"
              },
              "qIsCalculated": false
            }
          ],
          "qCalcCondMsg": "value",
          "qIsCalculated": false,
          "qIsOneAndOnlyOne": true,
          "qCardinalities": {
            "qCardinal": 123,
            "qHypercubeCardinal": 123,
            "qAllValuesCardinal": -1
          },
          "qLibraryId": "value",
          "qEffectiveDimensionName": "value"
        },
        "qExpressions": [
          {
            "qExpr": "value",
            "qError": {
              "qErrorCode": 123
            }
          }
        ],
        "qDataPages": [
          {
            "qMatrix": [
              [
                {
                  "qText": "value",
                  "qNum": 123,
                  "qElemNumber": 123,
                  "qState": "L",
                  "qIsEmpty": true,
                  "qIsTotalCell": true,
                  "qIsOtherCell": true,
                  "qFrequency": "value",
                  "qHighlightRanges": {
                    "qRanges": [
                      {
                        "qCharPos": 123,
                        "qCharCount": 123
                      }
                    ]
                  },
                  "qAttrExps": {
                    "qValues": [
                      {
                        "qText": "value",
                        "qNum": 123
                      }
                    ]
                  },
                  "qAttrDims": {
                    "qValues": [
                      {
                        "qText": "value",
                        "qElemNo": 123
                      }
                    ]
                  },
                  "qIsNull": true,
                  "qMiniChart": {
                    "qMatrix": [
                      [
                        {
                          "qText": "value",
                          "qNum": 123,
                          "qElemNumber": 123,
                          "qAttrExps": {
                            "qValues": [
                              {
                                "qText": "value",
                                "qNum": 123
                              }
                            ]
                          }
                        }
                      ]
                    ],
                    "qMin": 123,
                    "qMax": 123,
                    "qError": {
                      "qErrorCode": 123,
                      "qContext": "value",
                      "qExtendedMessage": "value"
                    }
                  },
                  "qInExtRow": true
                }
              ]
            ],
            "qTails": [
              {
                "qUp": 123,
                "qDown": 123
              }
            ],
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            },
            "qIsReduced": false
          }
        ]
      },
      "qMeasureList": {
        "qItems": [
          {
            "qInfo": {
              "qId": "value",
              "qType": "value"
            },
            "qMeta": {
              "qName": "value"
            },
            "qData": {}
          }
        ]
      },
      "qMediaList": {
        "qItems": [
          {
            "qUrlDef": "value",
            "qUrl": "value"
          }
        ]
      },
      "qNxLibraryDimension": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value",
        "qScriptGenerated": true,
        "qOrigin": "PROGRAM"
      },
      "qNxLibraryMeasure": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": true,
        "qOrigin": "PROGRAM"
      },
      "qSelectionObject": {
        "qBackCount": 123,
        "qForwardCount": 123,
        "qSelections": [
          {
            "qTotal": 123,
            "qIsNum": true,
            "qField": "value",
            "qLocked": true,
            "qOneAndOnlyOne": true,
            "qTextSearch": "value",
            "qSelectedCount": 123,
            "qSelected": "value",
            "qRangeInfo": [
              {
                "qRangeLo": -1e+300,
                "qRangeHi": -1e+300,
                "qMeasure": "value"
              }
            ],
            "qSortIndex": 123,
            "qStateCounts": {
              "qLocked": 123,
              "qSelected": 123,
              "qOption": 123,
              "qDeselected": 123,
              "qAlternative": 123,
              "qExcluded": 123,
              "qSelectedExcluded": 123,
              "qLockedExcluded": 123
            },
            "qSelectedFieldSelectionInfo": [
              {
                "qName": "value",
                "qFieldSelectionMode": "NORMAL"
              }
            ],
            "qNotSelectedFieldSelectionInfo": [
              {
                "qName": "value",
                "qFieldSelectionMode": "NORMAL"
              }
            ],
            "qSelectionThreshold": 123,
            "qReadableName": "value",
            "qIsHidden": true,
            "qDimensionReferences": [
              {
                "qId": "value",
                "qLabel": "value"
              }
            ]
          }
        ],
        "qStateName": "value"
      },
      "qStaticContentUrl": {
        "qUrl": "value"
      },
      "qTreeData": {
        "qStateName": "value",
        "qNodesOnDim": [
          123
        ],
        "qError": {
          "qErrorCode": 123,
          "qContext": "value",
          "qExtendedMessage": "value"
        },
        "qDimensionInfo": [
          {
            "qFallbackTitle": "value",
            "qApprMaxGlyphCount": 123,
            "qCardinal": 123,
            "qLocked": true,
            "qSortIndicator": "N",
            "qGroupFallbackTitles": [
              "value"
            ],
            "qGroupPos": 123,
            "qStateCounts": {
              "qLocked": 123,
              "qSelected": 123,
              "qOption": 123,
              "qDeselected": 123,
              "qAlternative": 123,
              "qExcluded": 123,
              "qSelectedExcluded": 123,
              "qLockedExcluded": 123
            },
            "qTags": [
              "value"
            ],
            "qError": {
              "qErrorCode": 123,
              "qContext": "value",
              "qExtendedMessage": "value"
            },
            "qDimensionType": "D",
            "qReverseSort": true,
            "qGrouping": "N",
            "qIsSemantic": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qIsAutoFormat": true,
            "qGroupFieldDefs": [
              "value"
            ],
            "qMin": 123,
            "qMax": 123,
            "qContinuousAxes": true,
            "qIsCyclic": true,
            "qDerivedField": true,
            "qMeasureInfo": [
              {
                "qFallbackTitle": "value",
                "qApprMaxGlyphCount": 123,
                "qCardinal": 123,
                "qSortIndicator": "N",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qMin": 123,
                "qMax": 123,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                },
                "qReverseSort": true,
                "qIsAutoFormat": true,
                "qAttrExprInfo": [
                  {
                    "qMin": 123,
                    "qMax": 123,
                    "qFallbackTitle": "value",
                    "qMinText": "value",
                    "qMaxText": "value",
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qIsAutoFormat": true
                  }
                ],
                "qAttrDimInfo": [
                  {
                    "qCardinal": 123,
                    "qSize": {
                      "qcx": 123,
                      "qcy": 123
                    },
                    "qFallbackTitle": "value",
                    "qLocked": true,
                    "qError": {
                      "qErrorCode": 123,
                      "qContext": "value",
                      "qExtendedMessage": "value"
                    },
                    "qIsCalculated": false
                  }
                ],
                "qCalcCondMsg": "value",
                "qLibraryId": "value",
                "qTrendLines": [
                  {
                    "qType": "AVERAGE",
                    "qError": {
                      "qErrorCode": 123,
                      "qContext": "value",
                      "qExtendedMessage": "value"
                    },
                    "qCoeff": [
                      123
                    ],
                    "qR2": 123,
                    "qExpression": "value",
                    "qElemNo": 123
                  }
                ],
                "qMiniChart": {
                  "qYMin": 123,
                  "qYMax": 123,
                  "qXMin": 123,
                  "qXMax": 123,
                  "qAttrExprInfo": [
                    {
                      "qMin": 123,
                      "qMax": 123,
                      "qFallbackTitle": "value",
                      "qMinText": "value",
                      "qMaxText": "value",
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qIsAutoFormat": true
                    }
                  ],
                  "qError": {
                    "qErrorCode": 123,
                    "qContext": "value",
                    "qExtendedMessage": "value"
                  }
                }
              }
            ],
            "qAttrExprInfo": [
              {
                "qMin": 123,
                "qMax": 123,
                "qFallbackTitle": "value",
                "qMinText": "value",
                "qMaxText": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qIsAutoFormat": true
              }
            ],
            "qAttrDimInfo": [
              {
                "qCardinal": 123,
                "qSize": {
                  "qcx": 123,
                  "qcy": 123
                },
                "qFallbackTitle": "value",
                "qLocked": true,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                },
                "qIsCalculated": false
              }
            ],
            "qCalcCondMsg": "value",
            "qIsCalculated": false,
            "qIsOneAndOnlyOne": true,
            "qCardinalities": {
              "qCardinal": 123,
              "qHypercubeCardinal": 123,
              "qAllValuesCardinal": -1
            },
            "qLibraryId": "value",
            "qEffectiveDimensionName": "value"
          }
        ],
        "qEffectiveInterColumnSortOrder": [
          123
        ],
        "qHasOtherValues": true,
        "qTitle": "value",
        "qLastExpandedPos": {
          "qx": 123,
          "qy": 123
        },
        "qCalcCondMsg": "value",
        "qTreeDataPages": [
          {
            "qText": "value",
            "qValue": 123,
            "qElemNo": 123,
            "qGroupPos": 123,
            "qGroupSize": 123,
            "qRow": 123,
            "qType": "V",
            "qValues": [
              {
                "qText": "value",
                "qValue": 123,
                "qAttrExps": {
                  "qValues": [
                    {
                      "qText": "value",
                      "qNum": 123
                    }
                  ]
                },
                "qAttrDims": {
                  "qValues": [
                    {
                      "qText": "value",
                      "qElemNo": 123
                    }
                  ]
                }
              }
            ],
            "qNodes": [],
            "qAttrExps": {
              "qValues": [
                {
                  "qText": "value",
                  "qNum": 123
                }
              ]
            },
            "qAttrDims": {
              "qValues": [
                {
                  "qText": "value",
                  "qElemNo": 123
                }
              ]
            },
            "qMaxPos": [
              123
            ],
            "qMinNeg": [
              123
            ],
            "qCanExpand": true,
            "qCanCollapse": true,
            "qState": "L",
            "qTreePath": [
              123
            ]
          }
        ],
        "qMeasureInfo": [
          {
            "qFallbackTitle": "value",
            "qApprMaxGlyphCount": 123,
            "qCardinal": 123,
            "qSortIndicator": "N",
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qMin": 123,
            "qMax": 123,
            "qError": {
              "qErrorCode": 123,
              "qContext": "value",
              "qExtendedMessage": "value"
            },
            "qReverseSort": true,
            "qIsAutoFormat": true,
            "qAttrExprInfo": [
              {
                "qMin": 123,
                "qMax": 123,
                "qFallbackTitle": "value",
                "qMinText": "value",
                "qMaxText": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qIsAutoFormat": true
              }
            ],
            "qAttrDimInfo": [
              {
                "qCardinal": 123,
                "qSize": {
                  "qcx": 123,
                  "qcy": 123
                },
                "qFallbackTitle": "value",
                "qLocked": true,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                },
                "qIsCalculated": false
              }
            ],
            "qCalcCondMsg": "value",
            "qLibraryId": "value",
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                },
                "qCoeff": [
                  123
                ],
                "qR2": 123,
                "qExpression": "value",
                "qElemNo": 123
              }
            ],
            "qMiniChart": {
              "qYMin": 123,
              "qYMax": 123,
              "qXMin": 123,
              "qXMax": 123,
              "qAttrExprInfo": [
                {
                  "qMin": 123,
                  "qMax": 123,
                  "qFallbackTitle": "value",
                  "qMinText": "value",
                  "qMaxText": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qIsAutoFormat": true
                }
              ],
              "qError": {
                "qErrorCode": 123,
                "qContext": "value",
                "qExtendedMessage": "value"
              }
            }
          }
        ]
      },
      "qUndoInfo": {
        "qUndoCount": 123,
        "qRedoCount": 123
      },
      "qVariableList": {
        "qItems": [
          {
            "qName": "value",
            "qDescription": "value",
            "qDefinition": "value",
            "qIsConfig": false,
            "qIsReserved": false,
            "qMeta": {
              "qName": "value"
            },
            "qInfo": {
              "qId": "value",
              "qType": "value"
            },
            "qData": {},
            "qIsScriptCreated": true
          }
        ]
      }
    }
  }
}

GenericObject GetLinkedObjects

()

Lists the linked objects to a generic object, a dimension or a measure.

Response

  • qItems array of objects
    Show qItems properties
    • qRootId string

      Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object.

    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.

Errors

array
GenericErrors

GetLinkedObjects()

enigma.js
const result = await genericObject.getLinkedObjects()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetLinkedObjects"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qItems": [
      {
        "qRootId": "value",
        "qInfo": {
          "qId": "value",
          "qType": "value"
        }
      }
    ]
  }
}

GenericObject GetListObjectData

(qPath, qPages)

Retrieves the values of a list object. A data set is returned.

Limitations on the number of cells

The maximum for the combined total number of cells across all pages is:

  • 10,000 cells. If this limit is exceeded, a calc-pages-too-large error with code 7009 is returned.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qListObjectDef .

  • qPages array of objects
    Required

    Array of pages you are interested in.

    Show qPages properties
    • qLeft integer

      Position from the left. Corresponds to the first column.

      format = int32

    • qTop integer

      Position from the top. Corresponds to the first row.

      format = int32

    • qWidth integer

      Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

    • qHeight integer

      Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

      format = int32

Response

  • qDataPages array of objects
    Show qDataPages properties
    • qMatrix array of arrays

      Array of data.

      Show qMatrix properties
      • qText string

        Some text. This parameter is optional.

      • qNum number

        A value. This parameter is optional.

        format = double

      • qElemNumber integer

        Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

        • -1: the cell is a Total cell. It shows a total.
        • -2: the cell is a Null cell.
        • -3: the cell belongs to the group Others .
        • -4: the cell is empty. Applies to pivot tables.

        format = int32

      • qState string

        Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"

      • qIsEmpty boolean

        Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .

      • qIsTotalCell boolean

        Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.

      • qIsOtherCell boolean

        Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.

      • qFrequency string

        Frequency of the value. This parameter is optional.

      • qHighlightRanges object
        Show qHighlightRanges properties
        • qRanges array of objects

          Ranges of highlighted values.

          Show qRanges properties
          • qCharPos integer

            Position of the first search occurrence.

            format = int32

          • qCharCount integer

            Number of occurrences found.

            format = int32

      • qAttrExps object
        Show qAttrExps properties
        • qValues array of objects

          List of attribute expressions values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value.

          • qNum number

            Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

            format = double

      • qAttrDims object
        Show qAttrDims properties
        • qValues array of objects

          List of values.

          Show qValues properties
          • qText string

            Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.

          • qElemNo integer

            Element number.

            format = int32

      • qIsNull boolean

        Is set to true if the value is Null.

      • qMiniChart object
        Show qMiniChart properties
        • qMatrix array of arrays

          Array of data.

          Show qMatrix properties
          • qText string

            Some text.

          • qNum number

            A value. This parameter is optional.

            format = double

          • qElemNumber integer

            Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:

            • -1: the cell is a Total cell. It shows a total.
            • -2: the cell is a Null cell.
            • -3: the cell belongs to the group Others .
            • -4: the cell is empty. Applies to pivot tables.

            format = int32

          • qAttrExps object
            Show qAttrExps properties
            • qValues array of objects

              List of attribute expressions values.

              Show qValues properties
              • qText string

                Text related to the attribute expression value.

              • qNum number

                Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.

                format = double

        • qMin number

          format = double

        • qMax number

          format = double

        • qError object
          Show qError properties
          • qErrorCode integer

            Error code. This parameter is always displayed in case of error.

            format = int32

          • qContext string

            Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.

          • qExtendedMessage string

            Internal information from the server. This parameter is optional.
      • qInExtRow boolean
    • qTails array of objects

      Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .

      Show qTails properties
      • qUp integer

        Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.

        format = int32

      • qDown integer

        Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.

        format = int32

    • qArea object
      Show qArea properties
      • qLeft integer

        Position from the left. Corresponds to the first column.

        format = int32

      • qTop integer

        Position from the top. Corresponds to the first row.

        format = int32

      • qWidth integer

        Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

      • qHeight integer

        Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

        format = int32

    • qIsReduced boolean

      Is set to true, if the data have been reduced. The default value is false.

      default = false

Errors

array
GenericErrors

GetListObjectData(qPath, qPages)

enigma.js
const result = await genericObject.getListObjectData("value", [
  {
    "qLeft": 123,
    "qTop": 123,
    "qWidth": 123,
    "qHeight": 123
  }
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetListObjectData",
  "params": {
    "qPath": "value",
    "qPages": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qDataPages": [
      {
        "qMatrix": [
          [
            {
              "qText": "value",
              "qNum": 123,
              "qElemNumber": 123,
              "qState": "L",
              "qIsEmpty": true,
              "qIsTotalCell": true,
              "qIsOtherCell": true,
              "qFrequency": "value",
              "qHighlightRanges": {
                "qRanges": [
                  {
                    "qCharPos": 123,
                    "qCharCount": 123
                  }
                ]
              },
              "qAttrExps": {
                "qValues": [
                  {
                    "qText": "value",
                    "qNum": 123
                  }
                ]
              },
              "qAttrDims": {
                "qValues": [
                  {
                    "qText": "value",
                    "qElemNo": 123
                  }
                ]
              },
              "qIsNull": true,
              "qMiniChart": {
                "qMatrix": [
                  [
                    {
                      "qText": "value",
                      "qNum": 123,
                      "qElemNumber": 123,
                      "qAttrExps": {
                        "qValues": [
                          {
                            "qText": "value",
                            "qNum": 123
                          }
                        ]
                      }
                    }
                  ]
                ],
                "qMin": 123,
                "qMax": 123,
                "qError": {
                  "qErrorCode": 123,
                  "qContext": "value",
                  "qExtendedMessage": "value"
                }
              },
              "qInExtRow": true
            }
          ]
        ],
        "qTails": [
          {
            "qUp": 123,
            "qDown": 123
          }
        ],
        "qArea": {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        },
        "qIsReduced": false
      }
    ]
  }
}

GenericObject GetParent

()

Returns the type of the object and the corresponding handle to the parent object in the hiearchy.

Response

  • qReturn object
    Show qReturn properties
    • qType string

      The native type of the object.

    • qHandle integer

      The handle used to connect to object.

      format = int32

    • qGenericType string

      The type of the object.

    • qGenericId string

      Object ID.

Errors

array
GenericErrors

GetParent()

enigma.js
const result = await genericObject.getParent()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetParent"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qReturn": {
      "qType": "value",
      "qHandle": 123,
      "qGenericType": "value",
      "qGenericId": "value"
    }
  }
}

GenericObject GetProperties

()

Returns the identifier, the type and the properties of the object. Because it is not mandatory to set all properties when you define an object, the GetProperties method may show properties that were not set. In that case, default values are given. If the object contains some soft properties, the soft properties are not returned by the GetProperties method. Use the GetEffectiveProperties method instead. If the object is linked to another object, the properties of the linking object are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

The properties depends on the generic object type, see [properties](genericobject-layout.html).
If the member delta is set to true in the request object, only the delta is retrieved.

Response

  • qProp object
    Show qProp properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qExtendsId string

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDef object

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qType string

        Type of the app list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDef object

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qIncludePatches boolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDef object

      Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

      Show qChildListDef properties
      • qData object

        Contains dynamic JSON data specified by the client.
    • qDimensionListDef object

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDef object

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDef object

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDef object

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystem boolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHidden boolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemantic boolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTables boolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnly boolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFields boolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicit boolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDef object

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qIncludeElemValue boolean
        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowTotal boolean
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
      • qMeasures array of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qInterColumnSortOrder array of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qInitialDataFetch array of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionMode string

        Can be one of: "N""D1""S""C""ST"

      • qMode string

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPos integer

        default = -1, format = int32, default = -1

      • qNoOfLeftDims integer

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpanded boolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCells integer

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAbove boolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentMode boolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qSortbyYValue integer

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qColumnOrder array of integers

        The order of the columns.

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qDynamicScript array of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.

      • qSuppressMeasureTotals boolean

        When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
    • qLayoutExclude object

      Contains JSON to be excluded from validation.

    • qListObjectDef object

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveField integer

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

          Alias of the dimension.
      • qAutoSortByState object
        Show qAutoSortByState properties
        • qDisplayNumberOfRows integer

          This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyMode string

        Can be one of: "N""V""P""R"

      • qShowAlternatives boolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetch array of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressions array of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qLibraryId string

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedView boolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDef object

      Defines the list of measures.

      Show qMeasureListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qMediaListDef object

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDef object
      Show qNxLibraryDimensionDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDef object
      Show qNxLibraryMeasureDef properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

        Can be one of: "N""H""C"

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDef object

      To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

      Properties

      "qSelectionObjectDef": {}

      Show qSelectionObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDef object
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrl string

        Relative path of the thumbnail.
    • qStringExpression object

      Properties

      Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string
      The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      A string expression is not evaluated, if the expression is surrounded by simple quotes.
      The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
      Show qStringExpression properties
      • qExpr string
    • qTreeDataDef object

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qValueExprs array of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrder array of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qOpenFullyExpanded boolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qInitialDataFetch array of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodes integer

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodes array of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qArea object
            Show qArea properties
            • qLeft integer

              Position from the left. Corresponds to the first column.

              format = int32

            • qTop integer

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidth integer

              Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

            • qHeight integer

              Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

          • qAllValues boolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevels object
          Show qTreeLevels properties
          • qLeft integer

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepth integer

            Number of dimensions to include in the tree.

            default = -1, format = int32, default = -1

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension.

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qValueExprs array of objects

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.
    • qUndoInfoDef object

      Defines if an object should contain information on the number of possible undo and redo.

      Properties

      "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

    • qValueExpression object

      Properties

      Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string.
      The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      The expression is evaluated as a numeric.
      Show qValueExpression properties
      • qExpr string
    • qVariableListDef object

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qType string

        Type of variables to include in the list.

      • qShowReserved boolean

        Shows the reserved variables if set to true.

      • qShowConfig boolean

        Shows the system variables if set to true.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qShowSession boolean

        Shows the session variables if set to true.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object

Errors

array
GenericErrors

GetProperties()

enigma.js
const result = await genericObject.getProperties()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetProperties"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qProp": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qExtendsId": "value",
      "qMetaDef": {},
      "qStateName": "value",
      "qAppObjectListDef": {
        "qType": "value",
        "qData": {}
      },
      "qBookmarkListDef": {
        "qType": "value",
        "qData": {},
        "qIncludePatches": true
      },
      "qChildListDef": {
        "qData": {}
      },
      "qDimensionListDef": {
        "qType": "value",
        "qData": {}
      },
      "qEmbeddedSnapshotDef": {},
      "qExtensionListDef": {},
      "qFieldListDef": {
        "qShowSystem": false,
        "qShowHidden": false,
        "qShowSemantic": false,
        "qShowSrcTables": false,
        "qShowDefinitionOnly": false,
        "qShowDerivedFields": false,
        "qShowImplicit": false
      },
      "qHyperCubeDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qNullSuppression": true,
            "qIncludeElemValue": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowTotal": true,
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCond": {
              "qv": "value"
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            }
          }
        ],
        "qMeasures": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qReductionMode": "N",
        "qMode": "S",
        "qPseudoDimPos": -1,
        "qNoOfLeftDims": -1,
        "qAlwaysFullyExpanded": false,
        "qMaxStackedCells": 5000,
        "qPopulateMissing": false,
        "qShowTotalsAbove": false,
        "qIndentMode": false,
        "qCalcCond": {
          "qv": "value"
        },
        "qSortbyYValue": 0,
        "qTitle": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qColumnOrder": [
          123
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qDynamicScript": [
          "value"
        ],
        "qContextSetExpression": "value",
        "qSuppressMeasureTotals": true
      },
      "qLayoutExclude": {},
      "qListObjectDef": {
        "qStateName": "value",
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qAutoSortByState": {
          "qDisplayNumberOfRows": 123
        },
        "qFrequencyMode": "N",
        "qShowAlternatives": true,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qExpressions": [
          {
            "qExpr": "value",
            "qLibraryId": "value"
          }
        ],
        "qDirectQuerySimplifiedView": true
      },
      "qMeasureListDef": {
        "qType": "value",
        "qData": {}
      },
      "qMediaListDef": {},
      "qNxLibraryDimensionDef": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value",
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qNxLibraryMeasureDef": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qSelectionObjectDef": {
        "qStateName": "value"
      },
      "qStaticContentUrlDef": {
        "qUrl": "value"
      },
      "qStringExpression": {
        "qExpr": "value"
      },
      "qTreeDataDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qValueExprs": [
              {
                "qLibraryId": "value",
                "qDef": {
                  "qLabel": "value",
                  "qDescription": "value",
                  "qTags": [
                    "value"
                  ],
                  "qGrouping": "N",
                  "qDef": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qRelative": true,
                  "qBrutalSum": true,
                  "qAggrFunc": "value",
                  "qAccumulate": 123,
                  "qReverseSort": true,
                  "qActiveExpression": 123,
                  "qExpressions": [
                    "value"
                  ],
                  "qLabelExpression": "value"
                },
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qAttributeDimensions": [
                  {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qAttribute": true
                  }
                ],
                "qCalcCond": {
                  "qv": "value"
                },
                "qCalcCondition": {
                  "qCond": {
                    "qv": "value"
                  },
                  "qMsg": {
                    "qv": "value"
                  }
                },
                "qTrendLines": [
                  {
                    "qType": "AVERAGE",
                    "qXColIx": -1,
                    "qCalcR2": false,
                    "qContinuousXAxis": "Never",
                    "qMultiDimMode": "Multi"
                  }
                ],
                "qMiniChartDef": {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qOtherTotalSpec": {
                    "qOtherMode": "OTHER_OFF",
                    "qOtherCounted": {
                      "qv": "value"
                    },
                    "qOtherLimit": {
                      "qv": "value"
                    },
                    "qOtherLimitMode": "OTHER_GE_LIMIT",
                    "qSuppressOther": false,
                    "qForceBadValueKeeping": true,
                    "qApplyEvenWhenPossiblyWrongResult": true,
                    "qGlobalOtherGrouping": false,
                    "qOtherCollapseInnerDimensions": false,
                    "qOtherSortMode": "OTHER_SORT_DEFAULT",
                    "qTotalMode": "TOTAL_OFF",
                    "qReferencedExpression": {
                      "qv": "value"
                    }
                  },
                  "qMaxNumberPoints": -1,
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qNullSuppression": true
                }
              }
            ],
            "qNullSuppression": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ]
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qOpenFullyExpanded": false,
        "qPopulateMissing": false,
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTitle": {
          "qv": "value"
        },
        "qInitialDataFetch": [
          {
            "qMaxNbrOfNodes": 123,
            "qTreeNodes": [
              {
                "qArea": {
                  "qLeft": 123,
                  "qTop": 123,
                  "qWidth": 123,
                  "qHeight": 123
                },
                "qAllValues": true
              }
            ],
            "qTreeLevels": {
              "qLeft": 123,
              "qDepth": -1
            }
          }
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qContextSetExpression": "value"
      },
      "qUndoInfoDef": {},
      "qValueExpression": {
        "qExpr": "value"
      },
      "qVariableListDef": {
        "qType": "value",
        "qShowReserved": true,
        "qShowConfig": true,
        "qData": {},
        "qShowSession": true
      }
    }
  }
}

GenericObject GetSnapshotObject

()

Returns the type of the object and the corresponding handle.

Response

  • qReturn object
    Show qReturn properties
    • qType string

      The native type of the object.

    • qHandle integer

      The handle used to connect to object.

      format = int32

    • qGenericType string

      The type of the object.

    • qGenericId string

      Object ID.

Errors

array
GenericErrors

GetSnapshotObject()

enigma.js
const result = await genericObject.getSnapshotObject()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "GetSnapshotObject"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qReturn": {
      "qType": "value",
      "qHandle": 123,
      "qGenericType": "value",
      "qGenericId": "value"
    }
  }
}

GenericObject Lock

(qPath, qColIndices?)

Locks the selected values of a generic object.

Parameters

  • qPath string
    Required

    Path to the definition of the object. For example, /qListObjectDef .

  • qColIndices array of integers

    Dimension numbers or dimension indexes where the lock should apply. Dimension numbers/indexes start from 0. If this parameter is not set, the selected values in all dimensions are locked.

Response

object

Errors

array
GenericErrors

Lock(qPath, qColIndices?)

enigma.js
const result = await genericObject.lock("value", [
  123
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "Lock",
  "params": {
    "qPath": "value",
    "qColIndices": [
      123
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject MultiRangeSelectHyperCubeValues

(qPath, qRanges, qOrMode?, qDeselectOnlyOneSelected?)

Makes multiple range selections in measures.

This method applies to hypercubes. For example, bar charts, tables and scatter plots.
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains some invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qRanges array of objects
    Required

    Ranges of selections.

    Show qRanges properties
    • qRanges array of objects
      Show qRanges properties
      • qRange object
        Show qRange properties
        • qMin number

          Lowest value in the range

          format = double

        • qMax number

          Highest value in the range

          format = double

        • qMinInclEq boolean

          If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

        • qMaxInclEq boolean

          If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
      • qMeasureIx integer

        Number of the measure to select. Numbering starts from 0.

        format = int32

    • qColumnsToSelect array of integers
  • qOrMode boolean

    Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false.

  • qDeselectOnlyOneSelected boolean

    Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

MultiRangeSelectHyperCubeValues(qPath, qRanges, qOrMode?, qDeselectOnlyOneSelected?)

enigma.js
const result = await genericObject.multiRangeSelectHyperCubeValues("value", [
  {
    "qRanges": [
      {
        "qRange": {
          "qMin": 123,
          "qMax": 123,
          "qMinInclEq": true,
          "qMaxInclEq": true
        },
        "qMeasureIx": 123
      }
    ],
    "qColumnsToSelect": [
      123
    ]
  }
], true, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "MultiRangeSelectHyperCubeValues",
  "params": {
    "qPath": "value",
    "qRanges": [
      {
        "qRanges": [
          {
            "qRange": {
              "qMin": 123,
              "qMax": 123,
              "qMinInclEq": true,
              "qMaxInclEq": true
            },
            "qMeasureIx": 123
          }
        ],
        "qColumnsToSelect": [
          123
        ]
      }
    ],
    "qOrMode": true,
    "qDeselectOnlyOneSelected": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject MultiRangeSelectTreeDataValues

(qPath, qRanges, qOrMode?, qDeselectOnlyOneSelected?)

Parameters

  • qPath string
    Required
  • qRanges array of objects
    Required
    Show qRanges properties
    • qRanges array of objects

      An array of Ranges.

      Show qRanges properties
      • qRange object
        Show qRange properties
        • qMin number

          Lowest value in the range

          format = double

        • qMax number

          Highest value in the range

          format = double

        • qMinInclEq boolean

          If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

        • qMaxInclEq boolean

          If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
      • qMeasureIx integer

        Number of the measure to select. Numbering starts from 0.

        format = int32

      • qDimensionIx integer

        Number of the dimension to select measure from. Numbering starts from 0.

        format = int32

  • qOrMode boolean
  • qDeselectOnlyOneSelected boolean

Response

  • qSuccess boolean

Errors

array
GenericErrors

MultiRangeSelectTreeDataValues(qPath, qRanges, qOrMode?, qDeselectOnlyOneSelected?)

enigma.js
const result = await genericObject.multiRangeSelectTreeDataValues("value", [
  {
    "qRanges": [
      {
        "qRange": {
          "qMin": 123,
          "qMax": 123,
          "qMinInclEq": true,
          "qMaxInclEq": true
        },
        "qMeasureIx": 123,
        "qDimensionIx": 123
      }
    ]
  }
], true, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "MultiRangeSelectTreeDataValues",
  "params": {
    "qPath": "value",
    "qRanges": [
      {
        "qRanges": [
          {
            "qRange": {
              "qMin": 123,
              "qMax": 123,
              "qMinInclEq": true,
              "qMaxInclEq": true
            },
            "qMeasureIx": 123,
            "qDimensionIx": 123
          }
        ]
      }
    ],
    "qOrMode": true,
    "qDeselectOnlyOneSelected": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject Publish

()

Publishes a generic object.

This operation is not applicable for Qlik Sense Desktop.

Response

object

Errors

array
GenericErrors

Publish()

enigma.js
const result = await genericObject.publish()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "Publish"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject RangeSelectHyperCubeValues

(qPath, qRanges, qColumnsToSelect?, qOrMode?, qDeselectOnlyOneSelected?)

Makes range selections in measures.

This method applies to hypercubes. For example, bar charts, tables and scatter plots.
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains some invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qRanges array of objects
    Required

    Ranges of selections.

    Show qRanges properties
    • qRange object
      Show qRange properties
      • qMin number

        Lowest value in the range

        format = double

      • qMax number

        Highest value in the range

        format = double

      • qMinInclEq boolean

        If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

      • qMaxInclEq boolean

        If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
    • qMeasureIx integer

      Number of the measure to select. Numbering starts from 0.

      format = int32

  • qColumnsToSelect array of integers

    Indicates which dimensions to select. The dimensions numbering starts at 0 (first dimension is 0). If the array is empty, all dimensions are selected.

  • qOrMode boolean

    Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false.

  • qDeselectOnlyOneSelected boolean

    Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

RangeSelectHyperCubeValues(qPath, qRanges, qColumnsToSelect?, qOrMode?, qDeselectOnlyOneSelected?)

enigma.js
const result = await genericObject.rangeSelectHyperCubeValues("value", [
  {
    "qRange": {
      "qMin": 123,
      "qMax": 123,
      "qMinInclEq": true,
      "qMaxInclEq": true
    },
    "qMeasureIx": 123
  }
], [
  123
], true, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "RangeSelectHyperCubeValues",
  "params": {
    "qPath": "value",
    "qRanges": [
      {
        "qRange": {
          "qMin": 123,
          "qMax": 123,
          "qMinInclEq": true,
          "qMaxInclEq": true
        },
        "qMeasureIx": 123
      }
    ],
    "qColumnsToSelect": [
      123
    ],
    "qOrMode": true,
    "qDeselectOnlyOneSelected": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject RemoveGroup

(qPath, qGroupId)
Experimental

You can use the RemoveGroup method with any object that contains an object grouping definition. This method allows you to remove a group of objects directly. This action only removes the group, not any of its members.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example /qNxGroupDef .

  • qGroupId string
    Required

    Name of the group to be removed. May not be an empty string.

Response

object

Errors

array
GenericErrors

RemoveGroup(qPath, qGroupId)

enigma.js
const result = await genericObject.removeGroup("value", "value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "RemoveGroup",
  "params": {
    "qPath": "value",
    "qGroupId": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject RemoveGroupMembers

(qPath, qMembers, qTargetGroupId?)
Experimental

You can use the RemoveGroupMembers method with any object that contains an object grouping definition. This method allows you to remove one or more members from an existing group of objects directly.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example /qNxGroupDef .

  • qMembers array of strings
    Required

    Array of IDs for the objects and/or subgroups to remove from the group.

  • qTargetGroupId string

    Name of the group the Members will be removed from (if not the called object).

Response

object

Errors

array
GenericErrors

RemoveGroupMembers(qPath, qMembers, qTargetGroupId?)

enigma.js
const result = await genericObject.removeGroupMembers("value", [
  "value"
], "value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "RemoveGroupMembers",
  "params": {
    "qPath": "value",
    "qMembers": [
      "value"
    ],
    "qTargetGroupId": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject ResetMadeSelections

()

Resets all selections made in selection mode.

Response

object

Errors

array
GenericErrors

ResetMadeSelections()

enigma.js
const result = await genericObject.resetMadeSelections()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "ResetMadeSelections"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject SearchListObjectFor

(qPath, qMatch)

Searches for a string in a list object.

This method applies to list objects (objects with one dimension).
The search results can be displayed using the _GetLayout Method_.
The operation is successful if **qSuccess** is set to true.

Parameters

  • qPath string
    Required

    Path to the definition of the list object. For example, /qListObjectDef .

  • qMatch string
    Required

    Search string. Wild card characters are allowed. The search is not case sensitive. Examples:

    • P*U*: retrieves only values that start with P and contain U
    • P U S: retrieves values that start with P, U or S

Response

  • qSuccess boolean

Errors

array
GenericErrors

SearchListObjectFor(qPath, qMatch)

enigma.js
const result = await genericObject.searchListObjectFor("value", "value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SearchListObjectFor",
  "params": {
    "qPath": "value",
    "qMatch": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectHyperCubeCells

(qPath, qRowIndices, qColIndices, qSoftLock?, qDeselectOnlyOneSelected?)

Makes selections in multiple dimensions and measures.

This method applies to hypercubes, such as bar charts, tables and scatter plots.
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains some invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qRowIndices array of integers
    Required

    Array of row indexes to select, starting from 0. If the array is empty [ ] , all rows are selected.

  • qColIndices array of integers
    Required

    Indexes of the columns to select, starting from 0. A column corresponds to a dimension in the order they are added to the hypercube. If a column is hidden it is ignored, qColIndex n refers to the n:th visible column (starting from zero). Example: If the hypercube has two dimensions:

    • [0] selects the first column (i.e the first dimension).
    • [1] selects the second column (i.e the second dimension).

    If the array is empty [ ] , all columns are selected.

  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected.

  • qDeselectOnlyOneSelected boolean

    Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectHyperCubeCells(qPath, qRowIndices, qColIndices, qSoftLock?, qDeselectOnlyOneSelected?)

enigma.js
const result = await genericObject.selectHyperCubeCells("value", [
  123
], [
  123
], true, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectHyperCubeCells",
  "params": {
    "qPath": "value",
    "qRowIndices": [
      123
    ],
    "qColIndices": [
      123
    ],
    "qSoftLock": true,
    "qDeselectOnlyOneSelected": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectHyperCubeContinuousRange

(qPath, qRanges, qSoftLock?)

The following is returned in the output:

The operation is successful if **qSuccess** is set to true.

Parameters

  • qPath string
    Required

    Path to the definition of the object. For example, /qHyperCubeDef .

  • qRanges array of objects
    Required

    Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals. If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to true then Min and Max values will be selected.

    Show qRanges properties
    • qRange object
      Show qRange properties
      • qMin number

        Lowest value in the range

        format = double

      • qMax number

        Highest value in the range

        format = double

      • qMinInclEq boolean

        If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

      • qMaxInclEq boolean

        If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
    • qDimIx integer

      Dimension index.

      format = int32

  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectHyperCubeContinuousRange(qPath, qRanges, qSoftLock?)

enigma.js
const result = await genericObject.selectHyperCubeContinuousRange("value", [
  {
    "qRange": {
      "qMin": 123,
      "qMax": 123,
      "qMinInclEq": true,
      "qMaxInclEq": true
    },
    "qDimIx": 123
  }
], true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectHyperCubeContinuousRange",
  "params": {
    "qPath": "value",
    "qRanges": [
      {
        "qRange": {
          "qMin": 123,
          "qMax": 123,
          "qMinInclEq": true,
          "qMaxInclEq": true
        },
        "qDimIx": 123
      }
    ],
    "qSoftLock": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectHyperCubeValues

(qPath, qDimNo, qValues, qToggleMode)

Selects some values in one dimension. The values are identified by their element numbers.

This method applies to charts, tables and scatter plots.
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains some invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qDimNo integer
    Required

    Dimension number or index to select. Dimension numbers/index start from 0.

  • qValues array of integers
    Required

    Element numbers of the field to select. You can select multiple elements; the separator is the comma.

  • qToggleMode boolean
    Required

    Set to true to toggle.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectHyperCubeValues(qPath, qDimNo, qValues, qToggleMode)

enigma.js
const result = await genericObject.selectHyperCubeValues("value", 123, [
  123
], true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectHyperCubeValues",
  "params": {
    "qPath": "value",
    "qDimNo": 123,
    "qValues": [
      123
    ],
    "qToggleMode": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectListObjectAll

(qPath, qSoftLock?)

Selects all values of a field.

This method applies to list objects (objects with one dimension).
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains some invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qListObjectDef .

  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectListObjectAll(qPath, qSoftLock?)

enigma.js
const result = await genericObject.selectListObjectAll("value", true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectListObjectAll",
  "params": {
    "qPath": "value",
    "qSoftLock": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectListObjectAlternative

(qPath, qSoftLock?)

Selects all alternative values in a specific field.

This method applies to list objects (objects with one dimension).
If a field contains at least one selected value, the values that are neither selected nor excluded are alternatives values.
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains some invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qListObjectDef .

  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectListObjectAlternative(qPath, qSoftLock?)

enigma.js
const result = await genericObject.selectListObjectAlternative("value", true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectListObjectAlternative",
  "params": {
    "qPath": "value",
    "qSoftLock": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectListObjectContinuousRange

(qPath, qRanges, qSoftLock?)

The following is returned in the output:

The operation is successful if **qSuccess** is set to true.

Parameters

  • qPath string
    Required

    Path to the definition of the object. For example, /qHyperCubeDef .

  • qRanges array of objects
    Required

    Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals. If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to true then Min and Max values will be selected.

    Show qRanges properties
    • qMin number

      Lowest value in the range

      format = double

    • qMax number

      Highest value in the range

      format = double

    • qMinInclEq boolean

      If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

    • qMaxInclEq boolean

      If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectListObjectContinuousRange(qPath, qRanges, qSoftLock?)

enigma.js
const result = await genericObject.selectListObjectContinuousRange("value", [
  {
    "qMin": 123,
    "qMax": 123,
    "qMinInclEq": true,
    "qMaxInclEq": true
  }
], true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectListObjectContinuousRange",
  "params": {
    "qPath": "value",
    "qRanges": [
      {
        "qMin": 123,
        "qMax": 123,
        "qMinInclEq": true,
        "qMaxInclEq": true
      }
    ],
    "qSoftLock": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectListObjectExcluded

(qPath, qSoftLock?)

Inverts the current selections in a specific field.

This method applies to list objects (objects with one dimension).
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains some invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qListObjectDef .

  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectListObjectExcluded(qPath, qSoftLock?)

enigma.js
const result = await genericObject.selectListObjectExcluded("value", true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectListObjectExcluded",
  "params": {
    "qPath": "value",
    "qSoftLock": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectListObjectPossible

(qPath, qSoftLock?)

Selects all possible values of a list object.

This method applies to list objects (objects with one dimension).
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qListObjectDef .

  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectListObjectPossible(qPath, qSoftLock?)

enigma.js
const result = await genericObject.selectListObjectPossible("value", true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectListObjectPossible",
  "params": {
    "qPath": "value",
    "qSoftLock": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectListObjectValues

(qPath, qValues, qToggleMode, qSoftLock?)

Makes single selections in dimensions.

This method applies to list objects only.
The member **Change** returns the handles of the objects that are updated following the selections. _qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases: * The object contains invalid fields (fields that are not in the data model). * The selection applies to a locked field. * A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qListObjectDef .

  • qValues array of integers
    Required

    Element numbers to select. You can select multiple values; the separator is the comma.

  • qToggleMode boolean
    Required

    Set to true to toggle.

  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectListObjectValues(qPath, qValues, qToggleMode, qSoftLock?)

enigma.js
const result = await genericObject.selectListObjectValues("value", [
  123
], true, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectListObjectValues",
  "params": {
    "qPath": "value",
    "qValues": [
      123
    ],
    "qToggleMode": true,
    "qSoftLock": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SelectPivotCells

(qPath, qSelections, qSoftLock?, qDeselectOnlyOneSelected?)
This method only applies to hypercubes that are not represented as straight tables. The parameter _qMode_ in _HyperCubeDef_ must be set either to _P_  or _K_ .

Pivot table

Makes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.

Stacked table

Makes selections in the left dimension cells of a stacked table or in the data matrix.

There is no top dimensions in a stacked table. A stacked table can only contain one measure.

The member Change returns the handles of the objects that are updated following the selections. qSuccess is set to true if the selections are successful and is set to false in the following cases:

  • The object contains some invalid fields (fields that are not in the data model).
  • The selection applies to a locked field.
  • A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters

  • qPath string
    Required

    Path to the definition of the object. For example, /qHyperCubeDef .

  • qSelections array of objects
    Required

    Information about the selections to perform.

    Show qSelections properties
    • qType string

      Can be one of: "D""T""L"

    • qCol integer

      Column index to select. Indexing starts from 0. If the cell's type is:

      • D, the index is based on the data matrix.
      • T, the index is based on the data matrix.
      • L, the index is based on the left dimensions indexes.

      format = int32

    • qRow integer

      Row index to select. Indexing starts from 0. If the cell's type is:

      • D, the index is based on the data matrix.
      • T, the index is based on the top dimensions indexes.
      • L, the index is based on the data matrix.

      format = int32

  • qSoftLock boolean

    Set to true to ignore locks; in that case, locked fields can be selected.

  • qDeselectOnlyOneSelected boolean

    Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.

Response

  • qSuccess boolean

Errors

array
GenericErrors

SelectPivotCells(qPath, qSelections, qSoftLock?, qDeselectOnlyOneSelected?)

enigma.js
const result = await genericObject.selectPivotCells("value", [
  {
    "qType": "D",
    "qCol": 123,
    "qRow": 123
  }
], true, true)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SelectPivotCells",
  "params": {
    "qPath": "value",
    "qSelections": [
      {
        "qType": "D",
        "qCol": 123,
        "qRow": 123
      }
    ],
    "qSoftLock": true,
    "qDeselectOnlyOneSelected": true
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "qSuccess": true
  }
}

GenericObject SetActiveField

(qPath, qDimNo, qNewIndex)
Experimental

You can use the SetActiveField method with any object that contains a cyclic group as a dimension. This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken. A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qDimNo integer
    Required

    Dimension number or index starting from 0. The default value is 0.

  • qNewIndex integer
    Required

    Index of the field to jump to.

Response

object

Errors

array
GenericErrors

SetActiveField(qPath, qDimNo, qNewIndex)

enigma.js
const result = await genericObject.setActiveField("value", 123, 123)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetActiveField",
  "params": {
    "qPath": "value",
    "qDimNo": 123,
    "qNewIndex": 123
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject SetChildArrayOrder

(qIds)

Sets the order of the children in a generic object.

To change the order of the children in a generic object, the identifiers of all the children must be included in the list of the identifiers (in _qIds_ ).

Parameters

  • qIds array of strings
    Required

    List of the children identifiers.

Response

object

Errors

array
GenericErrors

SetChildArrayOrder(qIds)

enigma.js
const result = await genericObject.setChildArrayOrder([
  "value"
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetChildArrayOrder",
  "params": {
    "qIds": [
      "value"
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject SetFullPropertyTree

(qPropEntry)

Sets the properties of:

  • A generic object.
  • The children of the generic object.
  • The bookmarks/embedded snapshots of the generic object.
If the _SetFullPropertyTree method_ is asked to set some properties to a child that does not exist, it creates the child.
The type of an object cannot be updated.

Parameters

  • qPropEntry object
    Required

    Information about the generic object entry.

    Show qPropEntry properties
    • qProperty object
      Show qProperty properties
      • qInfo object
        Show qInfo properties
        • qId string

          Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

        • qType string

          Type of the object. This parameter is mandatory.
      • qExtendsId string

        Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

      • qMetaDef object

        Used to collect metadata.

        Properties

        Semantic type with an empty structure.

      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qAppObjectListDef object

        Defines the list of objects in an app.

        An app object is a generic object created at app level.
        Show qAppObjectListDef properties
        • qType string

          Type of the app list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qBookmarkListDef object

        Defines the list of bookmarks.

        Show qBookmarkListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.

        • qIncludePatches boolean

          Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
      • qChildListDef object

        Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

        Show qChildListDef properties
        • qData object

          Contains dynamic JSON data specified by the client.
      • qDimensionListDef object

        Defines the lists of dimensions.

        Show qDimensionListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qEmbeddedSnapshotDef object

        Defines the embedded snapshot in a generic object.

        Properties

        "EmbeddedSnapshotDef": {}

      • qExtensionListDef object

        Obsolete, use qrs API's to fetch extensions.

      • qFieldListDef object

        Defines the fields to show.

        Show qFieldListDef properties
        • qShowSystem boolean

          Shows the system tables if set to true. Default is false.

          default = false

        • qShowHidden boolean

          Shows the hidden fields if set to true. Default is false.

          default = false

        • qShowSemantic boolean

          Show the semantic fields if set to true. Default is false.

          default = false

        • qShowSrcTables boolean

          Shows the tables and fields present in the data model viewer if set to true. Default is false.

          default = false

        • qShowDefinitionOnly boolean

          Shows the fields defined on the fly if set to true. Default is false.

          default = false

        • qShowDerivedFields boolean

          Shows the fields and derived fields if set to true. Default is false.

          default = false

        • qShowImplicit boolean

          Shows the Direct Discovery measure fields if set to true. Default is false.

          default = false

      • qHyperCubeDef object

        Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

        Show qHyperCubeDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qDimensions array of objects

          Array of dimensions.

          Show qDimensions properties
          • qLibraryId string

            Refers to a dimension stored in the library.

          • qDef object
            Show qDef properties
            • qGrouping string

              Can be one of: "N""H""C"

            • qFieldDefs array of strings

              Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

            • qFieldLabels array of strings

              Array of field labels. This parameter is optional.

            • qSortCriterias array of objects

              Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

              Show qSortCriterias properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qNumberPresentations array of objects

              Defines the format of the value. This parameter is optional.

              Show qNumberPresentations properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveField integer

              Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

              format = int32

            • qLabelExpression string

              Label expression. This parameter is optional.

            • qAlias string

              Alias of the dimension.
          • qNullSuppression boolean

            If set to true, no null values are returned.

          • qIncludeElemValue boolean
          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qShowTotal boolean
          • qShowAll boolean

            If set to true, all dimension values are shown.

          • qOtherLabel object
            Show qOtherLabel properties
            • qv string

              Expression evaluated to string.
          • qTotalLabel object
            Show qTotalLabel properties
            • qv string

              Expression evaluated to string.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
        • qMeasures array of objects

          Array of measures.

          Show qMeasures properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qInterColumnSortOrder array of integers

          Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

        • qSuppressZero boolean

          Removes zero values.

          default = false

        • qSuppressMissing boolean

          Removes missing values.

          default = false

        • qInitialDataFetch array of objects

          Initial data set.

          Show qInitialDataFetch properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qReductionMode string

          Can be one of: "N""D1""S""C""ST"

        • qMode string

          Can be one of: "S""P""K""T""D"

        • qPseudoDimPos integer

          default = -1, format = int32, default = -1

        • qNoOfLeftDims integer

          Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

          • Four dimensions in the following order: Country, City, Product and Category.
          • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
          • Three left dimensions ( qNoOfLeftDims is set to 3).

          implies that:

          • The index 0 corresponds to the left dimension Country.
          • The index 1 corresponds to the pseudo dimension.
          • The index 2 corresponds to the left dimension City.
          • Product and Category are top dimensions.

          Another example:

          • Four dimensions in the following order: Country, City, Product and Category.
          • Three left dimensions ( qNoOfLeftDims is set to 3).
          • One pseudo dimension.
          • The property qInterColumnSortOrder is left empty.

          Implies that:

          • The index 0 corresponds to the left dimension Country.
          • The index 1 corresponds to the left dimension City.
          • The index 2 corresponds to the left dimension Product.
          • Category is a top dimension.
          • The pseudo dimension is a top dimension.

          default = -1, format = int32, default = -1

        • qAlwaysFullyExpanded boolean

          If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

          default = false

        • qMaxStackedCells integer

          Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

          default = 5000, format = int32, default = 5000

        • qPopulateMissing boolean

          If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

          default = false

        • qShowTotalsAbove boolean

          If set to true, the total (if any) is shown on the first row. The default value is false.

          default = false

        • qIndentMode boolean

          This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

          default = false

        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qSortbyYValue integer

          To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

          default = 0, format = int8, default = 0

        • qTitle object
          Show qTitle properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qColumnOrder array of integers

          The order of the columns.

        • qExpansionState array of objects
          Experimental

          Expansion state per dimension for pivot mode ( qMode is P).

          Show qExpansionState properties
          • qExcludeList boolean
          • qPos object
            Show qPos properties
            • qDimName string
            • qElemNo array of integers
            • qElemValues array of strings
        • qDynamicScript array of strings
          Experimental

          Hypercube Modifier Dynamic script string

        • qContextSetExpression string

          Set expression valid for the whole cube, limiting computations to the specified set.

        • qSuppressMeasureTotals boolean

          When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
      • qLayoutExclude object

        Contains JSON to be excluded from validation.

      • qListObjectDef object

        Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

        Show qListObjectDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qAutoSortByState object
          Show qAutoSortByState properties
          • qDisplayNumberOfRows integer

            This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

            format = int32

        • qFrequencyMode string

          Can be one of: "N""V""P""R"

        • qShowAlternatives boolean

          If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

        • qInitialDataFetch array of objects

          Fetches an initial data set.

          Show qInitialDataFetch properties
          • qLeft integer

            Position from the left. Corresponds to the first column.

            format = int32

          • qTop integer

            Position from the top. Corresponds to the first row.

            format = int32

          • qWidth integer

            Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

          • qHeight integer

            Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

            format = int32

        • qExpressions array of objects

          Lists the expressions in the list object. This parameter is optional.

          Show qExpressions properties
          • qExpr string

            Value of the expression.

          • qLibraryId string

            Refers to an expression stored in the library.
        • qDirectQuerySimplifiedView boolean
          Experimental

          If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
      • qMeasureListDef object

        Defines the list of measures.

        Show qMeasureListDef properties
        • qType string

          Type of the list.

        • qData object

          Contains dynamic JSON data specified by the client.
      • qMediaListDef object

        Defines the list of media files.

        This struct is deprecated.

        Properties

        "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

      • qNxLibraryDimensionDef object
        Show qNxLibraryDimensionDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of dimension names.

        • qFieldLabels array of strings

          Array of dimension labels.

        • qLabelExpression string
        • qAlias string

          Alias of the dimension.

        • qScriptGenerated boolean Deprecated

          default = false

        • qOrigin string

          Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

      • qNxLibraryMeasureDef object
        Show qNxLibraryMeasureDef properties
        • qLabel string

          Label of the measure.

        • qDef string

          Definition of the measure.

        • qGrouping string

          Can be one of: "N""H""C"

        • qExpressions array of strings

          Array of expressions.

        • qActiveExpression integer

          Index to the active expression in a measure.

          format = int32

        • qLabelExpression string

          Optional expression used for dynamic label.

        • qNumFormat object

          Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

          Formatting mechanism

          The formatting mechanism depends on the type set in qType, as shown below:

          In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

          Type is DATE, TIME, TIMESTAMP or INTERVAL

          The following applies:

          • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
          • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
          • The properties qDec , qThou , qnDec , qUseThou are not used.

          Type is INTEGER

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

          Type is REAL

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
          • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
          • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is FIX

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
          • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

          Type is MONEY

          The following applies:

          • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
          • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

          Type is ASCII

          No formatting, qFmt is ignored.

          Show qNumFormat properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qScriptGenerated boolean Deprecated

          default = false

        • qOrigin string

          Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

      • qSelectionObjectDef object

        To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

        Properties

        "qSelectionObjectDef": {}

        Show qSelectionObjectDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .
      • qStaticContentUrlDef object
        In addition, this structure can contain dynamic properties.
        Show qStaticContentUrlDef properties
        • qUrl string

          Relative path of the thumbnail.
      • qStringExpression object

        Properties

        Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

        • < expression > is a string
        The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
        A string expression is not evaluated, if the expression is surrounded by simple quotes.
        The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
        Show qStringExpression properties
        • qExpr string
      • qTreeDataDef object

        Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

        Show qTreeDataDef properties
        • qStateName string

          Name of the alternate state. Default is current selections $ .

        • qDimensions array of objects

          Array of dimensions.

          Show qDimensions properties
          • qLibraryId string

            Refers to a dimension stored in the library.

          • qDef object
            Show qDef properties
            • qGrouping string

              Can be one of: "N""H""C"

            • qFieldDefs array of strings

              Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

            • qFieldLabels array of strings

              Array of field labels. This parameter is optional.

            • qSortCriterias array of objects

              Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

              Show qSortCriterias properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qNumberPresentations array of objects

              Defines the format of the value. This parameter is optional.

              Show qNumberPresentations properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveField integer

              Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

              format = int32

            • qLabelExpression string

              Label expression. This parameter is optional.

            • qAlias string

              Alias of the dimension.
          • qValueExprs array of objects

            List of measures.

            Show qValueExprs properties
            • qLibraryId string

              Refers to a measure stored in the library.

            • qDef object
              Show qDef properties
              • qLabel string

                Name of the measure. An empty string is returned as a default value. This parameter is optional.

              • qDescription string

                Description of the measure. An empty string is returned as a default value. This parameter is optional.

              • qTags array of strings

                Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

              • qGrouping string

                Can be one of: "N""H""C"

              • qDef string

                Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRelative boolean

                If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

              • qBrutalSum boolean

                If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

              • qAggrFunc string

                Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

              • qAccumulate integer
                • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

                format = int32

              • qReverseSort boolean

                If set to true, it inverts the sort criteria in the field.

              • qActiveExpression integer

                Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

                format = int32

              • qExpressions array of strings

                Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

              • qLabelExpression string

                Label expression. This parameter is optional.
            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qAttributeDimensions array of objects

              List of attribute dimensions.

              Show qAttributeDimensions properties
              • qDef string

                Expression or field name.

              • qLibraryId string

                LibraryId for dimension.

              • qSortBy object
                Show qSortBy properties
                • qSortByState integer

                  Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                  format = int8

                • qSortByFrequency integer

                  Sorts the field values by frequency (number of occurrences in the field).

                  format = int8

                • qSortByNumeric integer

                  Sorts the field values by numeric value.

                  format = int8

                • qSortByAscii integer

                  Sorts the field by alphabetical order.

                  format = int8

                • qSortByLoadOrder integer

                  Sorts the field values by the initial load order.

                  format = int8

                • qSortByExpression integer

                  Sorts the field by expression.

                  format = int8

                • qExpression object
                  Show qExpression properties
                  • qv string

                    Expression evaluated to dual.
                • qSortByGreyness integer

                  format = int8

              • qAttribute boolean

                If set to true, this attribute will not affect the number of rows in the cube.
            • qCalcCond object
              Show qCalcCond properties
              • qv string

                Expression evaluated to dual.
            • qCalcCondition object
              Show qCalcCondition properties
              • qCond object
                Show qCond properties
                • qv string

                  Expression evaluated to dual.
              • qMsg object
                Show qMsg properties
                • qv string

                  Expression evaluated to string.
            • qTrendLines array of objects
              Experimental

              Specifies trendlines for this measure.

              Show qTrendLines properties
              • qType string

                Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

              • qXColIx integer

                The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

                default = -1, format = int32, default = -1

              • qCalcR2 boolean

                Set to true to calulatate the R2 score

                default = false

              • qContinuousXAxis string

                Can be one of: "Never""Possible""Time"

              • qMultiDimMode string

                Can be one of: "Multi""Sum"

            • qMiniChartDef object
              Show qMiniChartDef properties
              • qDef string

                Expression or field name.

              • qLibraryId string

                LibraryId for dimension.

              • qSortBy object
                Show qSortBy properties
                • qSortByState integer

                  Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                  format = int8

                • qSortByFrequency integer

                  Sorts the field values by frequency (number of occurrences in the field).

                  format = int8

                • qSortByNumeric integer

                  Sorts the field values by numeric value.

                  format = int8

                • qSortByAscii integer

                  Sorts the field by alphabetical order.

                  format = int8

                • qSortByLoadOrder integer

                  Sorts the field values by the initial load order.

                  format = int8

                • qSortByExpression integer

                  Sorts the field by expression.

                  format = int8

                • qExpression object
                  Show qExpression properties
                  • qv string

                    Expression evaluated to dual.
                • qSortByGreyness integer

                  format = int8

              • qOtherTotalSpec object
                Show qOtherTotalSpec properties
                • qOtherMode string

                  Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

                • qOtherCounted object
                  Show qOtherCounted properties
                  • qv string

                    Expression evaluated to dual.
                • qOtherLimit object
                  Show qOtherLimit properties
                  • qv string

                    Expression evaluated to dual.
                • qOtherLimitMode string

                  Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

                • qSuppressOther boolean

                  If set to true, the group Others is not displayed as a dimension value. The default value is false.

                  default = false

                • qForceBadValueKeeping boolean

                  This parameter is used when qOtherMode is set to:

                  • OTHER_ABS_LIMITED
                  • OTHER_REL_LIMITED
                  • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                  and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                  default = true

                • qApplyEvenWhenPossiblyWrongResult boolean

                  Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                  default = true

                • qGlobalOtherGrouping boolean

                  This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                  default = false

                • qOtherCollapseInnerDimensions boolean

                  If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                  default = false

                • qOtherSortMode string

                  Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

                • qTotalMode string

                  Can be one of: "TOTAL_OFF""TOTAL_EXPR"

                • qReferencedExpression object
                  Show qReferencedExpression properties
                  • qv string

                    Expression evaluated to string.
              • qMaxNumberPoints integer

                default = -1, format = int32, default = -1

              • qAttributeExpressions array of objects

                List of attribute expressions.

                Show qAttributeExpressions properties
                • qExpression string

                  Definition of the attribute expression. Example: "Max(OrderID)"

                • qLibraryId string

                  Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

                • qAttribute boolean

                  If set to true, this measure will not affect the number of rows in the cube.

                • qNumFormat object

                  Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                  Formatting mechanism

                  The formatting mechanism depends on the type set in qType, as shown below:

                  In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                  Type is DATE, TIME, TIMESTAMP or INTERVAL

                  The following applies:

                  • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                  • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                  • The properties qDec , qThou , qnDec , qUseThou are not used.

                  Type is INTEGER

                  The following applies:

                  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                  • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                  Type is REAL

                  The following applies:

                  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                  • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                  • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                  • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                  Type is FIX

                  The following applies:

                  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                  • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                  Type is MONEY

                  The following applies:

                  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                  • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                  Type is ASCII

                  No formatting, qFmt is ignored.

                  Show qNumFormat properties
                  • qType string

                    Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                  • qnDec integer

                    Number of decimals. Default is 10.

                    default = 10, format = int32, default = 10

                  • qUseThou integer

                    Defines whether or not a thousands separator must be used. Default is 0.

                    default = 0, format = int32, default = 0

                  • qFmt string

                    Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                  • qDec string

                    Defines the decimal separator. Example: .

                  • qThou string

                    Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
                • qLabel string

                  Label of the attribute expression.

                • qLabelExpression string

                  Optional expression used for dynamic label.
              • qNullSuppression boolean

                If set to true, no null values are returned.
          • qNullSuppression boolean

            If set to true, no null values are returned.

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qShowAll boolean

            If set to true, all dimension values are shown.

          • qOtherLabel object
            Show qOtherLabel properties
            • qv string

              Expression evaluated to string.
          • qTotalLabel object
            Show qTotalLabel properties
            • qv string

              Expression evaluated to string.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
        • qInterColumnSortOrder array of integers

          Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

        • qSuppressZero boolean

          Removes zero values.

          default = false

        • qSuppressMissing boolean

          Removes missing values.

          default = false

        • qOpenFullyExpanded boolean

          If this property is set to true, the cells are opened expanded. The default value is false.

          default = false

        • qPopulateMissing boolean

          If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

          default = false

        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTitle object
          Show qTitle properties
          • qv string

            Expression evaluated to string.
        • qInitialDataFetch array of objects

          Initial data set. This property is optional.

          Show qInitialDataFetch properties
          • qMaxNbrOfNodes integer

            Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

            format = int32

          • qTreeNodes array of objects

            Defines areas of the tree to be fetched. Areas must be defined left to right.

            Show qTreeNodes properties
            • qArea object
              Show qArea properties
              • qLeft integer

                Position from the left. Corresponds to the first column.

                format = int32

              • qTop integer

                Position from the top. Corresponds to the first row.

                format = int32

              • qWidth integer

                Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

                format = int32

              • qHeight integer

                Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

                format = int32

            • qAllValues boolean

              When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
          • qTreeLevels object
            Show qTreeLevels properties
            • qLeft integer

              The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

              format = int32

            • qDepth integer

              Number of dimensions to include in the tree.

              default = -1, format = int32, default = -1

        • qExpansionState array of objects
          Experimental

          Expansion state per dimension.

          Show qExpansionState properties
          • qExcludeList boolean
          • qPos object
            Show qPos properties
            • qDimName string
            • qElemNo array of integers
            • qElemValues array of strings
        • qValueExprs array of objects

          List of measures to calculate on the whole tree.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qContextSetExpression string

          Set expression valid for the whole cube, limiting computations to the specified set.
      • qUndoInfoDef object

        Defines if an object should contain information on the number of possible undo and redo.

        Properties

        "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

      • qValueExpression object

        Properties

        Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

        • < expression > is a string.
        The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
        The expression is evaluated as a numeric.
        Show qValueExpression properties
        • qExpr string
      • qVariableListDef object

        Defines the list of variables in an app.

        Show qVariableListDef properties
        • qType string

          Type of variables to include in the list.

        • qShowReserved boolean

          Shows the reserved variables if set to true.

        • qShowConfig boolean

          Shows the system variables if set to true.

        • qData object

          Contains dynamic JSON data specified by the client.

        • qShowSession boolean

          Shows the session variables if set to true.
      Show additional optional properties
      • object object
        Private
        Any of:
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
        • object
    • qChildren array of undefineds

      Information about the children of the generic object.

    • qEmbeddedSnapshotRef object
      Show qEmbeddedSnapshotRef properties
      • qProperties object
        Show qProperties properties
        • qInfo object
          Show qInfo properties
          • qId string

            Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

          • qType string

            Type of the object. This parameter is mandatory.
        • qMetaDef object

          Used to collect metadata.

          Properties

          Semantic type with an empty structure.

        • qIncludeVariables boolean
          Experimental

          If true all variables will be stored in the bookmark.

          default = false

        • qDistinctValues boolean
          Experimental

          If true all selected values will be stored distinct, i.e. searchstrings will not be kept.

          default = false

      • qBookmark object
        Show qBookmark properties
        • qStateData array of objects

          List of selections for each state.

          Show qStateData properties
          • qStateName string

            Name of the alternate state. Default is current selections: $

          • qFieldItems array of objects

            List of the selections.

            Show qFieldItems properties
            • qDef object
              Show qDef properties
              • qName string

                Name of the field.

              • qType string

                Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

            • qLocked boolean

              Indicates if the field is locked. Default is false.

            • qSelectInfo object
              Show qSelectInfo properties
              • qTextSearch string

                Text search string. Everything that matches the text is selected. This parameter is optional.

              • qRangeLo number

                Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qNumberFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumberFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRangeInfo array of objects

                This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

                Show qRangeInfo properties
                • qRangeLo number

                  Lowest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qRangeHi number

                  Highest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qMeasure string

                  Label of the measure.
              • qSoftLock boolean

                Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

                default = false

              • qContinuousRangeInfo array of objects

                List of information about ranges for selections.

                Show qContinuousRangeInfo properties
                • qMin number

                  Lowest value in the range

                  format = double

                • qMax number

                  Highest value in the range

                  format = double

                • qMinInclEq boolean

                  If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

                • qMaxInclEq boolean

                  If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
              • qSelectFieldSearch boolean

                This parameter is true if the TextSearch is a result of a Select Field operation.

                default = false

            • qValues array of objects
              Show qValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qExcludedValues array of objects

              List of excluded values. Either the list of selected values or the list of excluded values is displayed.

              Show qExcludedValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qAndMode boolean

              If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

            • qOneAndOnlyOne boolean

              If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

            • qValuesCount integer

              Count of selected values. Indicates if the Values field is loaded.

              default = -1, format = int32, default = -1

            • qExcludedValuesCount integer

              Count of excluded values. Indicates if the ExcludedValues field is loaded.

              default = -1, format = int32, default = -1

        • qUtcModifyTime number

          Time when the bookmark was created.

          format = double

        • qVariableItems array of objects

          List of the variables in the app at the time the bookmark was created.

          Show qVariableItems properties
          • qName string

            Name of the variable.

          • qValue object
            Show qValue properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qDefinition string

            The Reporting mode definition of the variable.
        • qPatches array of objects

          Softpatches to be applied with this bookmark.

          Show qPatches properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qPatches array of objects

            Array with patches.

            Show qPatches properties
            • qOp string

              Can be one of: "add""remove""replace"

            • qPath string

              Path to the property to add, remove or replace.

            • qValue string

              This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
          • qChildren array of undefineds

            Array with child objects and their patches.
        • qCyclicGroupStates array of objects

          Information about cyclic groups by zero-based index. This field is unused.

          Show qCyclicGroupStates properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qActiveField integer

            Active field of the cyclic group, identified by a zero-based index.

            format = int32

        • qGroupStates array of objects
          Experimental

          Information about cyclic groups indexed by field definition.

          Show qGroupStates properties
          • qInfo object
            Show qInfo properties
            • qId string

              Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

            • qType string

              Type of the object. This parameter is mandatory.
          • qActiveFieldDef string

            String defining the active field.
      • qClassicBookmark object
        Show qClassicBookmark properties
        • qId string
        • qName string
        • qUtcModifyTime number

          format = double

        • qUtcRecallTime number

          format = double

        • qRecallCount integer

          format = int32

        • qApplyAdditive boolean
        • qFieldItems array of objects
          Show qFieldItems properties
          • qDef object
            Show qDef properties
            • qName string

              Name of the field.

            • qType string

              Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

          • qLocked boolean

            Indicates if the field is locked. Default is false.

          • qSelectInfo object
            Show qSelectInfo properties
            • qTextSearch string

              Text search string. Everything that matches the text is selected. This parameter is optional.

            • qRangeLo number

              Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qRangeHi number

              Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

              default = -1e+300, format = double, default = -1e+300

            • qNumberFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumberFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRangeInfo array of objects

              This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

              Show qRangeInfo properties
              • qRangeLo number

                Lowest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value in the range.

                default = -1e+300, format = double, default = -1e+300

              • qMeasure string

                Label of the measure.
            • qSoftLock boolean

              Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

              default = false

            • qContinuousRangeInfo array of objects

              List of information about ranges for selections.

              Show qContinuousRangeInfo properties
              • qMin number

                Lowest value in the range

                format = double

              • qMax number

                Highest value in the range

                format = double

              • qMinInclEq boolean

                If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

              • qMaxInclEq boolean

                If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
            • qSelectFieldSearch boolean

              This parameter is true if the TextSearch is a result of a Select Field operation.

              default = false

          • qValues array of objects
            Show qValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qExcludedValues array of objects

            List of excluded values. Either the list of selected values or the list of excluded values is displayed.

            Show qExcludedValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qAndMode boolean

            If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

          • qOneAndOnlyOne boolean

            If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

          • qValuesCount integer

            Count of selected values. Indicates if the Values field is loaded.

            default = -1, format = int32, default = -1

          • qExcludedValuesCount integer

            Count of excluded values. Indicates if the ExcludedValues field is loaded.

            default = -1, format = int32, default = -1

        • qVariableItems array of objects
          Show qVariableItems properties
          • qName string

            Name of the variable.

          • qValue object
            Show qValue properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qDefinition string

            The Reporting mode definition of the variable.
        • qSheetId string
        • qObjects array of objects
          Show qObjects properties
          • qId string
          • qActive boolean
          • qShowMode integer

            format = byte

          • qScrollPos object
            Show qScrollPos properties
            • qUsePosition boolean
            • qPos object
              Show qPos properties
              • qx integer

                x-coordinate in pixels. The origin is the top left of the screen.

                format = int32

              • qy integer

                y-coordinate in pixels. The origin is the top left of the screen.

                format = int32

        • qApplyLayoutState boolean

          default = false

        • qShowPopupInfo boolean

          default = false

        • qInfoText string
        • qOwner string
        • qGroups array of objects
          Show qGroups properties
          • qId string
          • qCyclePos integer

            format = int32

        • qShow object
          Show qShow properties
          • qAlways boolean

            default = true

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
        • qApplyInputFieldValues boolean

          default = true

        • qInputFieldItems array of objects
          Show qInputFieldItems properties
          • qFieldName string
          • qValues array of objects
            Show qValues properties
            • qText string

              Text related to the field value. This parameter is optional.

            • qIsNumeric boolean

              Is set to true if the value is a numeric. This parameter is optional. Default is false.

            • qNumber number

              Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

              format = double

          • qPackedHashKeys array of integers
        • qObjectsLayout array of objects
          Show qObjectsLayout properties
          • qId string
          • qActive boolean
          • qShowMode integer

            format = byte

          • qScrollPos object
            Show qScrollPos properties
            • qUsePosition boolean
            • qPos object
              Show qPos properties
              • qx integer

                x-coordinate in pixels. The origin is the top left of the screen.

                format = int32

              • qy integer

                y-coordinate in pixels. The origin is the top left of the screen.

                format = int32

          • qExpansionInfo array of objects
            Show qExpansionInfo properties
            • qExcludeList boolean
            • qPos object
              Show qPos properties
              • qDimName string
              • qElemNo array of integers
              • qElemValues array of strings
          • qLeftCollapsed boolean
          • qTopCollapsed boolean
          • qSortData array of objects
            Show qSortData properties
            • qName string
            • qReversed boolean
          • qDimensionGroupPos array of objects
            Show qDimensionGroupPos properties
            • qGroupName string
            • qCurrentItemName string
          • qExpressionGroupPos array of objects
            Show qExpressionGroupPos properties
            • qGroupName string
            • qCurrentItemName string
          • qUseGraphMode boolean
          • qGraphMode string

            Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"

          • qActiveContainerChildObjectId string
          • qExtendedPivotState object
            Show qExtendedPivotState properties
            • qExpressionPosition integer

              format = byte

            • qNumberOfLeftDimensions integer

              format = byte

            • qDimensionNames array of strings
            • qEnableConditions array of strings
        • qIncludeSelectionState boolean

          default = true

        • qIncludeScrollPosition boolean
        • qAlternateStateData array of objects
          Show qAlternateStateData properties
          • qStateName string

            Name of the alternate state. Default is current selections: $

          • qFieldItems array of objects

            List of the selections.

            Show qFieldItems properties
            • qDef object
              Show qDef properties
              • qName string

                Name of the field.

              • qType string

                Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"

            • qLocked boolean

              Indicates if the field is locked. Default is false.

            • qSelectInfo object
              Show qSelectInfo properties
              • qTextSearch string

                Text search string. Everything that matches the text is selected. This parameter is optional.

              • qRangeLo number

                Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qRangeHi number

                Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.

                default = -1e+300, format = double, default = -1e+300

              • qNumberFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumberFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qRangeInfo array of objects

                This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.

                Show qRangeInfo properties
                • qRangeLo number

                  Lowest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qRangeHi number

                  Highest value in the range.

                  default = -1e+300, format = double, default = -1e+300

                • qMeasure string

                  Label of the measure.
              • qSoftLock boolean

                Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

                default = false

              • qContinuousRangeInfo array of objects

                List of information about ranges for selections.

                Show qContinuousRangeInfo properties
                • qMin number

                  Lowest value in the range

                  format = double

                • qMax number

                  Highest value in the range

                  format = double

                • qMinInclEq boolean

                  If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.

                • qMaxInclEq boolean

                  If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
              • qSelectFieldSearch boolean

                This parameter is true if the TextSearch is a result of a Select Field operation.

                default = false

            • qValues array of objects
              Show qValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qExcludedValues array of objects

              List of excluded values. Either the list of selected values or the list of excluded values is displayed.

              Show qExcludedValues properties
              • qText string

                Text related to the field value. This parameter is optional.

              • qIsNumeric boolean

                Is set to true if the value is a numeric. This parameter is optional. Default is false.

              • qNumber number

                Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

                format = double

            • qAndMode boolean

              If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.

            • qOneAndOnlyOne boolean

              If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.

            • qValuesCount integer

              Count of selected values. Indicates if the Values field is loaded.

              default = -1, format = int32, default = -1

            • qExcludedValuesCount integer

              Count of excluded values. Indicates if the ExcludedValues field is loaded.

              default = -1, format = int32, default = -1

        • qForAnnotations boolean
        • qIncludeAllVariables boolean

          default = false

      • qClassicMetadata object
        Show qClassicMetadata properties
        • qShared boolean
        • qUtcModifyTime number

          format = double

        • qSheetId string
        • qTemporary boolean
        • qRestrictedAccess boolean
        • qAccessList array of strings
        • qPersonalEditionHash_OBSOLETE string
        • qHidden boolean

          default = false

        • qLinkedTo array of strings

Response

object

Errors

array
GenericErrors

SetFullPropertyTree(qPropEntry)

enigma.js
const result = await genericObject.setFullPropertyTree({
  "qProperty": {
    "qInfo": {
      "qId": "value",
      "qType": "value"
    },
    "qExtendsId": "value",
    "qMetaDef": {},
    "qStateName": "value",
    "qAppObjectListDef": {
      "qType": "value",
      "qData": {}
    },
    "qBookmarkListDef": {
      "qType": "value",
      "qData": {},
      "qIncludePatches": true
    },
    "qChildListDef": {
      "qData": {}
    },
    "qDimensionListDef": {
      "qType": "value",
      "qData": {}
    },
    "qEmbeddedSnapshotDef": {},
    "qExtensionListDef": {},
    "qFieldListDef": {
      "qShowSystem": false,
      "qShowHidden": false,
      "qShowSemantic": false,
      "qShowSrcTables": false,
      "qShowDefinitionOnly": false,
      "qShowDerivedFields": false,
      "qShowImplicit": false
    },
    "qHyperCubeDef": {
      "qStateName": "value",
      "qDimensions": [
        {
          "qLibraryId": "value",
          "qDef": {
            "qGrouping": "N",
            "qFieldDefs": [
              "value"
            ],
            "qFieldLabels": [
              "value"
            ],
            "qSortCriterias": [
              {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              }
            ],
            "qNumberPresentations": [
              {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              }
            ],
            "qReverseSort": true,
            "qActiveField": 123,
            "qLabelExpression": "value",
            "qAlias": "value"
          },
          "qNullSuppression": true,
          "qIncludeElemValue": true,
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qShowTotal": true,
          "qShowAll": true,
          "qOtherLabel": {
            "qv": "value"
          },
          "qTotalLabel": {
            "qv": "value"
          },
          "qCalcCond": {
            "qv": "value"
          },
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qAttributeDimensions": [
            {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttribute": true
            }
          ],
          "qCalcCondition": {
            "qCond": {
              "qv": "value"
            },
            "qMsg": {
              "qv": "value"
            }
          }
        }
      ],
      "qMeasures": [
        {
          "qLibraryId": "value",
          "qDef": {
            "qLabel": "value",
            "qDescription": "value",
            "qTags": [
              "value"
            ],
            "qGrouping": "N",
            "qDef": "value",
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qRelative": true,
            "qBrutalSum": true,
            "qAggrFunc": "value",
            "qAccumulate": 123,
            "qReverseSort": true,
            "qActiveExpression": 123,
            "qExpressions": [
              "value"
            ],
            "qLabelExpression": "value"
          },
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qAttributeDimensions": [
            {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttribute": true
            }
          ],
          "qCalcCond": {
            "qv": "value"
          },
          "qCalcCondition": {
            "qCond": {
              "qv": "value"
            },
            "qMsg": {
              "qv": "value"
            }
          },
          "qTrendLines": [
            {
              "qType": "AVERAGE",
              "qXColIx": -1,
              "qCalcR2": false,
              "qContinuousXAxis": "Never",
              "qMultiDimMode": "Multi"
            }
          ],
          "qMiniChartDef": {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qMaxNumberPoints": -1,
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qNullSuppression": true
          }
        }
      ],
      "qInterColumnSortOrder": [
        123
      ],
      "qSuppressZero": false,
      "qSuppressMissing": false,
      "qInitialDataFetch": [
        {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        }
      ],
      "qReductionMode": "N",
      "qMode": "S",
      "qPseudoDimPos": -1,
      "qNoOfLeftDims": -1,
      "qAlwaysFullyExpanded": false,
      "qMaxStackedCells": 5000,
      "qPopulateMissing": false,
      "qShowTotalsAbove": false,
      "qIndentMode": false,
      "qCalcCond": {
        "qv": "value"
      },
      "qSortbyYValue": 0,
      "qTitle": {
        "qv": "value"
      },
      "qCalcCondition": {
        "qCond": {
          "qv": "value"
        },
        "qMsg": {
          "qv": "value"
        }
      },
      "qColumnOrder": [
        123
      ],
      "qExpansionState": [
        {
          "qExcludeList": true,
          "qPos": {
            "qDimName": "value",
            "qElemNo": [
              123
            ],
            "qElemValues": [
              "value"
            ]
          }
        }
      ],
      "qDynamicScript": [
        "value"
      ],
      "qContextSetExpression": "value",
      "qSuppressMeasureTotals": true
    },
    "qLayoutExclude": {},
    "qListObjectDef": {
      "qStateName": "value",
      "qLibraryId": "value",
      "qDef": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qSortCriterias": [
          {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          }
        ],
        "qNumberPresentations": [
          {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          }
        ],
        "qReverseSort": true,
        "qActiveField": 123,
        "qLabelExpression": "value",
        "qAlias": "value"
      },
      "qAutoSortByState": {
        "qDisplayNumberOfRows": 123
      },
      "qFrequencyMode": "N",
      "qShowAlternatives": true,
      "qInitialDataFetch": [
        {
          "qLeft": 123,
          "qTop": 123,
          "qWidth": 123,
          "qHeight": 123
        }
      ],
      "qExpressions": [
        {
          "qExpr": "value",
          "qLibraryId": "value"
        }
      ],
      "qDirectQuerySimplifiedView": true
    },
    "qMeasureListDef": {
      "qType": "value",
      "qData": {}
    },
    "qMediaListDef": {},
    "qNxLibraryDimensionDef": {
      "qGrouping": "N",
      "qFieldDefs": [
        "value"
      ],
      "qFieldLabels": [
        "value"
      ],
      "qLabelExpression": "value",
      "qAlias": "value",
      "qScriptGenerated": false,
      "qOrigin": "PROGRAM"
    },
    "qNxLibraryMeasureDef": {
      "qLabel": "value",
      "qDef": "value",
      "qGrouping": "N",
      "qExpressions": [
        "value"
      ],
      "qActiveExpression": 123,
      "qLabelExpression": "value",
      "qNumFormat": {
        "qType": "U",
        "qnDec": 10,
        "qUseThou": 0,
        "qFmt": "value",
        "qDec": "value",
        "qThou": "value"
      },
      "qScriptGenerated": false,
      "qOrigin": "PROGRAM"
    },
    "qSelectionObjectDef": {
      "qStateName": "value"
    },
    "qStaticContentUrlDef": {
      "qUrl": "value"
    },
    "qStringExpression": {
      "qExpr": "value"
    },
    "qTreeDataDef": {
      "qStateName": "value",
      "qDimensions": [
        {
          "qLibraryId": "value",
          "qDef": {
            "qGrouping": "N",
            "qFieldDefs": [
              "value"
            ],
            "qFieldLabels": [
              "value"
            ],
            "qSortCriterias": [
              {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              }
            ],
            "qNumberPresentations": [
              {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              }
            ],
            "qReverseSort": true,
            "qActiveField": 123,
            "qLabelExpression": "value",
            "qAlias": "value"
          },
          "qValueExprs": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qLabel": "value",
                "qDescription": "value",
                "qTags": [
                  "value"
                ],
                "qGrouping": "N",
                "qDef": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRelative": true,
                "qBrutalSum": true,
                "qAggrFunc": "value",
                "qAccumulate": 123,
                "qReverseSort": true,
                "qActiveExpression": 123,
                "qExpressions": [
                  "value"
                ],
                "qLabelExpression": "value"
              },
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ],
              "qCalcCond": {
                "qv": "value"
              },
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              },
              "qTrendLines": [
                {
                  "qType": "AVERAGE",
                  "qXColIx": -1,
                  "qCalcR2": false,
                  "qContinuousXAxis": "Never",
                  "qMultiDimMode": "Multi"
                }
              ],
              "qMiniChartDef": {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qOtherTotalSpec": {
                  "qOtherMode": "OTHER_OFF",
                  "qOtherCounted": {
                    "qv": "value"
                  },
                  "qOtherLimit": {
                    "qv": "value"
                  },
                  "qOtherLimitMode": "OTHER_GE_LIMIT",
                  "qSuppressOther": false,
                  "qForceBadValueKeeping": true,
                  "qApplyEvenWhenPossiblyWrongResult": true,
                  "qGlobalOtherGrouping": false,
                  "qOtherCollapseInnerDimensions": false,
                  "qOtherSortMode": "OTHER_SORT_DEFAULT",
                  "qTotalMode": "TOTAL_OFF",
                  "qReferencedExpression": {
                    "qv": "value"
                  }
                },
                "qMaxNumberPoints": -1,
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qNullSuppression": true
              }
            }
          ],
          "qNullSuppression": true,
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qShowAll": true,
          "qOtherLabel": {
            "qv": "value"
          },
          "qTotalLabel": {
            "qv": "value"
          },
          "qCalcCondition": {
            "qCond": {
              "qv": "value"
            },
            "qMsg": {
              "qv": "value"
            }
          },
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qAttributeDimensions": [
            {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttribute": true
            }
          ]
        }
      ],
      "qInterColumnSortOrder": [
        123
      ],
      "qSuppressZero": false,
      "qSuppressMissing": false,
      "qOpenFullyExpanded": false,
      "qPopulateMissing": false,
      "qCalcCondition": {
        "qCond": {
          "qv": "value"
        },
        "qMsg": {
          "qv": "value"
        }
      },
      "qTitle": {
        "qv": "value"
      },
      "qInitialDataFetch": [
        {
          "qMaxNbrOfNodes": 123,
          "qTreeNodes": [
            {
              "qArea": {
                "qLeft": 123,
                "qTop": 123,
                "qWidth": 123,
                "qHeight": 123
              },
              "qAllValues": true
            }
          ],
          "qTreeLevels": {
            "qLeft": 123,
            "qDepth": -1
          }
        }
      ],
      "qExpansionState": [
        {
          "qExcludeList": true,
          "qPos": {
            "qDimName": "value",
            "qElemNo": [
              123
            ],
            "qElemValues": [
              "value"
            ]
          }
        }
      ],
      "qValueExprs": [
        {
          "qLibraryId": "value",
          "qDef": {
            "qLabel": "value",
            "qDescription": "value",
            "qTags": [
              "value"
            ],
            "qGrouping": "N",
            "qDef": "value",
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qRelative": true,
            "qBrutalSum": true,
            "qAggrFunc": "value",
            "qAccumulate": 123,
            "qReverseSort": true,
            "qActiveExpression": 123,
            "qExpressions": [
              "value"
            ],
            "qLabelExpression": "value"
          },
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qAttributeDimensions": [
            {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttribute": true
            }
          ],
          "qCalcCond": {
            "qv": "value"
          },
          "qCalcCondition": {
            "qCond": {
              "qv": "value"
            },
            "qMsg": {
              "qv": "value"
            }
          },
          "qTrendLines": [
            {
              "qType": "AVERAGE",
              "qXColIx": -1,
              "qCalcR2": false,
              "qContinuousXAxis": "Never",
              "qMultiDimMode": "Multi"
            }
          ],
          "qMiniChartDef": {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qMaxNumberPoints": -1,
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qNullSuppression": true
          }
        }
      ],
      "qContextSetExpression": "value"
    },
    "qUndoInfoDef": {},
    "qValueExpression": {
      "qExpr": "value"
    },
    "qVariableListDef": {
      "qType": "value",
      "qShowReserved": true,
      "qShowConfig": true,
      "qData": {},
      "qShowSession": true
    }
  },
  "qChildren": [],
  "qEmbeddedSnapshotRef": {
    "qProperties": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qMetaDef": {},
      "qIncludeVariables": false,
      "qDistinctValues": false
    },
    "qBookmark": {
      "qStateData": [
        {
          "qStateName": "value",
          "qFieldItems": [
            {
              "qDef": {
                "qName": "value",
                "qType": "NOT_PRESENT"
              },
              "qLocked": true,
              "qSelectInfo": {
                "qTextSearch": "value",
                "qRangeLo": -1e+300,
                "qRangeHi": -1e+300,
                "qNumberFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRangeInfo": [
                  {
                    "qRangeLo": -1e+300,
                    "qRangeHi": -1e+300,
                    "qMeasure": "value"
                  }
                ],
                "qSoftLock": false,
                "qContinuousRangeInfo": [
                  {
                    "qMin": 123,
                    "qMax": 123,
                    "qMinInclEq": true,
                    "qMaxInclEq": true
                  }
                ],
                "qSelectFieldSearch": false
              },
              "qValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qExcludedValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qAndMode": true,
              "qOneAndOnlyOne": true,
              "qValuesCount": -1,
              "qExcludedValuesCount": -1
            }
          ]
        }
      ],
      "qUtcModifyTime": 123,
      "qVariableItems": [
        {
          "qName": "value",
          "qValue": {
            "qText": "value",
            "qIsNumeric": true,
            "qNumber": 123
          },
          "qDefinition": "value"
        }
      ],
      "qPatches": [
        {
          "qInfo": {
            "qId": "value",
            "qType": "value"
          },
          "qPatches": [
            {
              "qOp": "add",
              "qPath": "value",
              "qValue": "value"
            }
          ],
          "qChildren": []
        }
      ],
      "qCyclicGroupStates": [
        {
          "qInfo": {
            "qId": "value",
            "qType": "value"
          },
          "qActiveField": 123
        }
      ],
      "qGroupStates": [
        {
          "qInfo": {
            "qId": "value",
            "qType": "value"
          },
          "qActiveFieldDef": "value"
        }
      ]
    },
    "qClassicBookmark": {
      "qId": "value",
      "qName": "value",
      "qUtcModifyTime": 123,
      "qUtcRecallTime": 123,
      "qRecallCount": 123,
      "qApplyAdditive": true,
      "qFieldItems": [
        {
          "qDef": {
            "qName": "value",
            "qType": "NOT_PRESENT"
          },
          "qLocked": true,
          "qSelectInfo": {
            "qTextSearch": "value",
            "qRangeLo": -1e+300,
            "qRangeHi": -1e+300,
            "qNumberFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qRangeInfo": [
              {
                "qRangeLo": -1e+300,
                "qRangeHi": -1e+300,
                "qMeasure": "value"
              }
            ],
            "qSoftLock": false,
            "qContinuousRangeInfo": [
              {
                "qMin": 123,
                "qMax": 123,
                "qMinInclEq": true,
                "qMaxInclEq": true
              }
            ],
            "qSelectFieldSearch": false
          },
          "qValues": [
            {
              "qText": "value",
              "qIsNumeric": true,
              "qNumber": 123
            }
          ],
          "qExcludedValues": [
            {
              "qText": "value",
              "qIsNumeric": true,
              "qNumber": 123
            }
          ],
          "qAndMode": true,
          "qOneAndOnlyOne": true,
          "qValuesCount": -1,
          "qExcludedValuesCount": -1
        }
      ],
      "qVariableItems": [
        {
          "qName": "value",
          "qValue": {
            "qText": "value",
            "qIsNumeric": true,
            "qNumber": 123
          },
          "qDefinition": "value"
        }
      ],
      "qSheetId": "value",
      "qObjects": [
        {
          "qId": "value",
          "qActive": true,
          "qShowMode": 123,
          "qScrollPos": {
            "qUsePosition": true,
            "qPos": {
              "qx": 123,
              "qy": 123
            }
          }
        }
      ],
      "qApplyLayoutState": false,
      "qShowPopupInfo": false,
      "qInfoText": "value",
      "qOwner": "value",
      "qGroups": [
        {
          "qId": "value",
          "qCyclePos": 123
        }
      ],
      "qShow": {
        "qAlways": true,
        "qExpression": {
          "qv": "value"
        }
      },
      "qApplyInputFieldValues": true,
      "qInputFieldItems": [
        {
          "qFieldName": "value",
          "qValues": [
            {
              "qText": "value",
              "qIsNumeric": true,
              "qNumber": 123
            }
          ],
          "qPackedHashKeys": [
            123
          ]
        }
      ],
      "qObjectsLayout": [
        {
          "qId": "value",
          "qActive": true,
          "qShowMode": 123,
          "qScrollPos": {
            "qUsePosition": true,
            "qPos": {
              "qx": 123,
              "qy": 123
            }
          },
          "qExpansionInfo": [
            {
              "qExcludeList": true,
              "qPos": {
                "qDimName": "value",
                "qElemNo": [
                  123
                ],
                "qElemValues": [
                  "value"
                ]
              }
            }
          ],
          "qLeftCollapsed": true,
          "qTopCollapsed": true,
          "qSortData": [
            {
              "qName": "value",
              "qReversed": true
            }
          ],
          "qDimensionGroupPos": [
            {
              "qGroupName": "value",
              "qCurrentItemName": "value"
            }
          ],
          "qExpressionGroupPos": [
            {
              "qGroupName": "value",
              "qCurrentItemName": "value"
            }
          ],
          "qUseGraphMode": true,
          "qGraphMode": "GRAPH_MODE_BAR",
          "qActiveContainerChildObjectId": "value",
          "qExtendedPivotState": {
            "qExpressionPosition": 123,
            "qNumberOfLeftDimensions": 123,
            "qDimensionNames": [
              "value"
            ],
            "qEnableConditions": [
              "value"
            ]
          }
        }
      ],
      "qIncludeSelectionState": true,
      "qIncludeScrollPosition": true,
      "qAlternateStateData": [
        {
          "qStateName": "value",
          "qFieldItems": [
            {
              "qDef": {
                "qName": "value",
                "qType": "NOT_PRESENT"
              },
              "qLocked": true,
              "qSelectInfo": {
                "qTextSearch": "value",
                "qRangeLo": -1e+300,
                "qRangeHi": -1e+300,
                "qNumberFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRangeInfo": [
                  {
                    "qRangeLo": -1e+300,
                    "qRangeHi": -1e+300,
                    "qMeasure": "value"
                  }
                ],
                "qSoftLock": false,
                "qContinuousRangeInfo": [
                  {
                    "qMin": 123,
                    "qMax": 123,
                    "qMinInclEq": true,
                    "qMaxInclEq": true
                  }
                ],
                "qSelectFieldSearch": false
              },
              "qValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qExcludedValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qAndMode": true,
              "qOneAndOnlyOne": true,
              "qValuesCount": -1,
              "qExcludedValuesCount": -1
            }
          ]
        }
      ],
      "qForAnnotations": true,
      "qIncludeAllVariables": false
    },
    "qClassicMetadata": {
      "qShared": true,
      "qUtcModifyTime": 123,
      "qSheetId": "value",
      "qTemporary": true,
      "qRestrictedAccess": true,
      "qAccessList": [
        "value"
      ],
      "qPersonalEditionHash_OBSOLETE": "value",
      "qHidden": false,
      "qLinkedTo": [
        "value"
      ]
    }
  }
})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetFullPropertyTree",
  "params": {
    "qPropEntry": {
      "qProperty": {
        "qInfo": {
          "qId": "value",
          "qType": "value"
        },
        "qExtendsId": "value",
        "qMetaDef": {},
        "qStateName": "value",
        "qAppObjectListDef": {
          "qType": "value",
          "qData": {}
        },
        "qBookmarkListDef": {
          "qType": "value",
          "qData": {},
          "qIncludePatches": true
        },
        "qChildListDef": {
          "qData": {}
        },
        "qDimensionListDef": {
          "qType": "value",
          "qData": {}
        },
        "qEmbeddedSnapshotDef": {},
        "qExtensionListDef": {},
        "qFieldListDef": {
          "qShowSystem": false,
          "qShowHidden": false,
          "qShowSemantic": false,
          "qShowSrcTables": false,
          "qShowDefinitionOnly": false,
          "qShowDerivedFields": false,
          "qShowImplicit": false
        },
        "qHyperCubeDef": {
          "qStateName": "value",
          "qDimensions": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qGrouping": "N",
                "qFieldDefs": [
                  "value"
                ],
                "qFieldLabels": [
                  "value"
                ],
                "qSortCriterias": [
                  {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  }
                ],
                "qNumberPresentations": [
                  {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  }
                ],
                "qReverseSort": true,
                "qActiveField": 123,
                "qLabelExpression": "value",
                "qAlias": "value"
              },
              "qNullSuppression": true,
              "qIncludeElemValue": true,
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qShowTotal": true,
              "qShowAll": true,
              "qOtherLabel": {
                "qv": "value"
              },
              "qTotalLabel": {
                "qv": "value"
              },
              "qCalcCond": {
                "qv": "value"
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ],
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              }
            }
          ],
          "qMeasures": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qLabel": "value",
                "qDescription": "value",
                "qTags": [
                  "value"
                ],
                "qGrouping": "N",
                "qDef": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRelative": true,
                "qBrutalSum": true,
                "qAggrFunc": "value",
                "qAccumulate": 123,
                "qReverseSort": true,
                "qActiveExpression": 123,
                "qExpressions": [
                  "value"
                ],
                "qLabelExpression": "value"
              },
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ],
              "qCalcCond": {
                "qv": "value"
              },
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              },
              "qTrendLines": [
                {
                  "qType": "AVERAGE",
                  "qXColIx": -1,
                  "qCalcR2": false,
                  "qContinuousXAxis": "Never",
                  "qMultiDimMode": "Multi"
                }
              ],
              "qMiniChartDef": {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qOtherTotalSpec": {
                  "qOtherMode": "OTHER_OFF",
                  "qOtherCounted": {
                    "qv": "value"
                  },
                  "qOtherLimit": {
                    "qv": "value"
                  },
                  "qOtherLimitMode": "OTHER_GE_LIMIT",
                  "qSuppressOther": false,
                  "qForceBadValueKeeping": true,
                  "qApplyEvenWhenPossiblyWrongResult": true,
                  "qGlobalOtherGrouping": false,
                  "qOtherCollapseInnerDimensions": false,
                  "qOtherSortMode": "OTHER_SORT_DEFAULT",
                  "qTotalMode": "TOTAL_OFF",
                  "qReferencedExpression": {
                    "qv": "value"
                  }
                },
                "qMaxNumberPoints": -1,
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qNullSuppression": true
              }
            }
          ],
          "qInterColumnSortOrder": [
            123
          ],
          "qSuppressZero": false,
          "qSuppressMissing": false,
          "qInitialDataFetch": [
            {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            }
          ],
          "qReductionMode": "N",
          "qMode": "S",
          "qPseudoDimPos": -1,
          "qNoOfLeftDims": -1,
          "qAlwaysFullyExpanded": false,
          "qMaxStackedCells": 5000,
          "qPopulateMissing": false,
          "qShowTotalsAbove": false,
          "qIndentMode": false,
          "qCalcCond": {
            "qv": "value"
          },
          "qSortbyYValue": 0,
          "qTitle": {
            "qv": "value"
          },
          "qCalcCondition": {
            "qCond": {
              "qv": "value"
            },
            "qMsg": {
              "qv": "value"
            }
          },
          "qColumnOrder": [
            123
          ],
          "qExpansionState": [
            {
              "qExcludeList": true,
              "qPos": {
                "qDimName": "value",
                "qElemNo": [
                  123
                ],
                "qElemValues": [
                  "value"
                ]
              }
            }
          ],
          "qDynamicScript": [
            "value"
          ],
          "qContextSetExpression": "value",
          "qSuppressMeasureTotals": true
        },
        "qLayoutExclude": {},
        "qListObjectDef": {
          "qStateName": "value",
          "qLibraryId": "value",
          "qDef": {
            "qGrouping": "N",
            "qFieldDefs": [
              "value"
            ],
            "qFieldLabels": [
              "value"
            ],
            "qSortCriterias": [
              {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              }
            ],
            "qNumberPresentations": [
              {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              }
            ],
            "qReverseSort": true,
            "qActiveField": 123,
            "qLabelExpression": "value",
            "qAlias": "value"
          },
          "qAutoSortByState": {
            "qDisplayNumberOfRows": 123
          },
          "qFrequencyMode": "N",
          "qShowAlternatives": true,
          "qInitialDataFetch": [
            {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            }
          ],
          "qExpressions": [
            {
              "qExpr": "value",
              "qLibraryId": "value"
            }
          ],
          "qDirectQuerySimplifiedView": true
        },
        "qMeasureListDef": {
          "qType": "value",
          "qData": {}
        },
        "qMediaListDef": {},
        "qNxLibraryDimensionDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qLabelExpression": "value",
          "qAlias": "value",
          "qScriptGenerated": false,
          "qOrigin": "PROGRAM"
        },
        "qNxLibraryMeasureDef": {
          "qLabel": "value",
          "qDef": "value",
          "qGrouping": "N",
          "qExpressions": [
            "value"
          ],
          "qActiveExpression": 123,
          "qLabelExpression": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qScriptGenerated": false,
          "qOrigin": "PROGRAM"
        },
        "qSelectionObjectDef": {
          "qStateName": "value"
        },
        "qStaticContentUrlDef": {
          "qUrl": "value"
        },
        "qStringExpression": {
          "qExpr": "value"
        },
        "qTreeDataDef": {
          "qStateName": "value",
          "qDimensions": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qGrouping": "N",
                "qFieldDefs": [
                  "value"
                ],
                "qFieldLabels": [
                  "value"
                ],
                "qSortCriterias": [
                  {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  }
                ],
                "qNumberPresentations": [
                  {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  }
                ],
                "qReverseSort": true,
                "qActiveField": 123,
                "qLabelExpression": "value",
                "qAlias": "value"
              },
              "qValueExprs": [
                {
                  "qLibraryId": "value",
                  "qDef": {
                    "qLabel": "value",
                    "qDescription": "value",
                    "qTags": [
                      "value"
                    ],
                    "qGrouping": "N",
                    "qDef": "value",
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qRelative": true,
                    "qBrutalSum": true,
                    "qAggrFunc": "value",
                    "qAccumulate": 123,
                    "qReverseSort": true,
                    "qActiveExpression": 123,
                    "qExpressions": [
                      "value"
                    ],
                    "qLabelExpression": "value"
                  },
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qAttributeDimensions": [
                    {
                      "qDef": "value",
                      "qLibraryId": "value",
                      "qSortBy": {
                        "qSortByState": 123,
                        "qSortByFrequency": 123,
                        "qSortByNumeric": 123,
                        "qSortByAscii": 123,
                        "qSortByLoadOrder": 123,
                        "qSortByExpression": 123,
                        "qExpression": {
                          "qv": "value"
                        },
                        "qSortByGreyness": 123
                      },
                      "qAttribute": true
                    }
                  ],
                  "qCalcCond": {
                    "qv": "value"
                  },
                  "qCalcCondition": {
                    "qCond": {
                      "qv": "value"
                    },
                    "qMsg": {
                      "qv": "value"
                    }
                  },
                  "qTrendLines": [
                    {
                      "qType": "AVERAGE",
                      "qXColIx": -1,
                      "qCalcR2": false,
                      "qContinuousXAxis": "Never",
                      "qMultiDimMode": "Multi"
                    }
                  ],
                  "qMiniChartDef": {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qOtherTotalSpec": {
                      "qOtherMode": "OTHER_OFF",
                      "qOtherCounted": {
                        "qv": "value"
                      },
                      "qOtherLimit": {
                        "qv": "value"
                      },
                      "qOtherLimitMode": "OTHER_GE_LIMIT",
                      "qSuppressOther": false,
                      "qForceBadValueKeeping": true,
                      "qApplyEvenWhenPossiblyWrongResult": true,
                      "qGlobalOtherGrouping": false,
                      "qOtherCollapseInnerDimensions": false,
                      "qOtherSortMode": "OTHER_SORT_DEFAULT",
                      "qTotalMode": "TOTAL_OFF",
                      "qReferencedExpression": {
                        "qv": "value"
                      }
                    },
                    "qMaxNumberPoints": -1,
                    "qAttributeExpressions": [
                      {
                        "qExpression": "value",
                        "qLibraryId": "value",
                        "qAttribute": true,
                        "qNumFormat": {
                          "qType": "U",
                          "qnDec": 10,
                          "qUseThou": 0,
                          "qFmt": "value",
                          "qDec": "value",
                          "qThou": "value"
                        },
                        "qLabel": "value",
                        "qLabelExpression": "value"
                      }
                    ],
                    "qNullSuppression": true
                  }
                }
              ],
              "qNullSuppression": true,
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qShowAll": true,
              "qOtherLabel": {
                "qv": "value"
              },
              "qTotalLabel": {
                "qv": "value"
              },
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ]
            }
          ],
          "qInterColumnSortOrder": [
            123
          ],
          "qSuppressZero": false,
          "qSuppressMissing": false,
          "qOpenFullyExpanded": false,
          "qPopulateMissing": false,
          "qCalcCondition": {
            "qCond": {
              "qv": "value"
            },
            "qMsg": {
              "qv": "value"
            }
          },
          "qTitle": {
            "qv": "value"
          },
          "qInitialDataFetch": [
            {
              "qMaxNbrOfNodes": 123,
              "qTreeNodes": [
                {
                  "qArea": {
                    "qLeft": 123,
                    "qTop": 123,
                    "qWidth": 123,
                    "qHeight": 123
                  },
                  "qAllValues": true
                }
              ],
              "qTreeLevels": {
                "qLeft": 123,
                "qDepth": -1
              }
            }
          ],
          "qExpansionState": [
            {
              "qExcludeList": true,
              "qPos": {
                "qDimName": "value",
                "qElemNo": [
                  123
                ],
                "qElemValues": [
                  "value"
                ]
              }
            }
          ],
          "qValueExprs": [
            {
              "qLibraryId": "value",
              "qDef": {
                "qLabel": "value",
                "qDescription": "value",
                "qTags": [
                  "value"
                ],
                "qGrouping": "N",
                "qDef": "value",
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRelative": true,
                "qBrutalSum": true,
                "qAggrFunc": "value",
                "qAccumulate": 123,
                "qReverseSort": true,
                "qActiveExpression": 123,
                "qExpressions": [
                  "value"
                ],
                "qLabelExpression": "value"
              },
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qAttributeDimensions": [
                {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qAttribute": true
                }
              ],
              "qCalcCond": {
                "qv": "value"
              },
              "qCalcCondition": {
                "qCond": {
                  "qv": "value"
                },
                "qMsg": {
                  "qv": "value"
                }
              },
              "qTrendLines": [
                {
                  "qType": "AVERAGE",
                  "qXColIx": -1,
                  "qCalcR2": false,
                  "qContinuousXAxis": "Never",
                  "qMultiDimMode": "Multi"
                }
              ],
              "qMiniChartDef": {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qOtherTotalSpec": {
                  "qOtherMode": "OTHER_OFF",
                  "qOtherCounted": {
                    "qv": "value"
                  },
                  "qOtherLimit": {
                    "qv": "value"
                  },
                  "qOtherLimitMode": "OTHER_GE_LIMIT",
                  "qSuppressOther": false,
                  "qForceBadValueKeeping": true,
                  "qApplyEvenWhenPossiblyWrongResult": true,
                  "qGlobalOtherGrouping": false,
                  "qOtherCollapseInnerDimensions": false,
                  "qOtherSortMode": "OTHER_SORT_DEFAULT",
                  "qTotalMode": "TOTAL_OFF",
                  "qReferencedExpression": {
                    "qv": "value"
                  }
                },
                "qMaxNumberPoints": -1,
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qNullSuppression": true
              }
            }
          ],
          "qContextSetExpression": "value"
        },
        "qUndoInfoDef": {},
        "qValueExpression": {
          "qExpr": "value"
        },
        "qVariableListDef": {
          "qType": "value",
          "qShowReserved": true,
          "qShowConfig": true,
          "qData": {},
          "qShowSession": true
        }
      },
      "qChildren": [],
      "qEmbeddedSnapshotRef": {
        "qProperties": {
          "qInfo": {
            "qId": "value",
            "qType": "value"
          },
          "qMetaDef": {},
          "qIncludeVariables": false,
          "qDistinctValues": false
        },
        "qBookmark": {
          "qStateData": [
            {
              "qStateName": "value",
              "qFieldItems": [
                {
                  "qDef": {
                    "qName": "value",
                    "qType": "NOT_PRESENT"
                  },
                  "qLocked": true,
                  "qSelectInfo": {
                    "qTextSearch": "value",
                    "qRangeLo": -1e+300,
                    "qRangeHi": -1e+300,
                    "qNumberFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qRangeInfo": [
                      {
                        "qRangeLo": -1e+300,
                        "qRangeHi": -1e+300,
                        "qMeasure": "value"
                      }
                    ],
                    "qSoftLock": false,
                    "qContinuousRangeInfo": [
                      {
                        "qMin": 123,
                        "qMax": 123,
                        "qMinInclEq": true,
                        "qMaxInclEq": true
                      }
                    ],
                    "qSelectFieldSearch": false
                  },
                  "qValues": [
                    {
                      "qText": "value",
                      "qIsNumeric": true,
                      "qNumber": 123
                    }
                  ],
                  "qExcludedValues": [
                    {
                      "qText": "value",
                      "qIsNumeric": true,
                      "qNumber": 123
                    }
                  ],
                  "qAndMode": true,
                  "qOneAndOnlyOne": true,
                  "qValuesCount": -1,
                  "qExcludedValuesCount": -1
                }
              ]
            }
          ],
          "qUtcModifyTime": 123,
          "qVariableItems": [
            {
              "qName": "value",
              "qValue": {
                "qText": "value",
                "qIsNumeric": true,
                "qNumber": 123
              },
              "qDefinition": "value"
            }
          ],
          "qPatches": [
            {
              "qInfo": {
                "qId": "value",
                "qType": "value"
              },
              "qPatches": [
                {
                  "qOp": "add",
                  "qPath": "value",
                  "qValue": "value"
                }
              ],
              "qChildren": []
            }
          ],
          "qCyclicGroupStates": [
            {
              "qInfo": {
                "qId": "value",
                "qType": "value"
              },
              "qActiveField": 123
            }
          ],
          "qGroupStates": [
            {
              "qInfo": {
                "qId": "value",
                "qType": "value"
              },
              "qActiveFieldDef": "value"
            }
          ]
        },
        "qClassicBookmark": {
          "qId": "value",
          "qName": "value",
          "qUtcModifyTime": 123,
          "qUtcRecallTime": 123,
          "qRecallCount": 123,
          "qApplyAdditive": true,
          "qFieldItems": [
            {
              "qDef": {
                "qName": "value",
                "qType": "NOT_PRESENT"
              },
              "qLocked": true,
              "qSelectInfo": {
                "qTextSearch": "value",
                "qRangeLo": -1e+300,
                "qRangeHi": -1e+300,
                "qNumberFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qRangeInfo": [
                  {
                    "qRangeLo": -1e+300,
                    "qRangeHi": -1e+300,
                    "qMeasure": "value"
                  }
                ],
                "qSoftLock": false,
                "qContinuousRangeInfo": [
                  {
                    "qMin": 123,
                    "qMax": 123,
                    "qMinInclEq": true,
                    "qMaxInclEq": true
                  }
                ],
                "qSelectFieldSearch": false
              },
              "qValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qExcludedValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qAndMode": true,
              "qOneAndOnlyOne": true,
              "qValuesCount": -1,
              "qExcludedValuesCount": -1
            }
          ],
          "qVariableItems": [
            {
              "qName": "value",
              "qValue": {
                "qText": "value",
                "qIsNumeric": true,
                "qNumber": 123
              },
              "qDefinition": "value"
            }
          ],
          "qSheetId": "value",
          "qObjects": [
            {
              "qId": "value",
              "qActive": true,
              "qShowMode": 123,
              "qScrollPos": {
                "qUsePosition": true,
                "qPos": {
                  "qx": 123,
                  "qy": 123
                }
              }
            }
          ],
          "qApplyLayoutState": false,
          "qShowPopupInfo": false,
          "qInfoText": "value",
          "qOwner": "value",
          "qGroups": [
            {
              "qId": "value",
              "qCyclePos": 123
            }
          ],
          "qShow": {
            "qAlways": true,
            "qExpression": {
              "qv": "value"
            }
          },
          "qApplyInputFieldValues": true,
          "qInputFieldItems": [
            {
              "qFieldName": "value",
              "qValues": [
                {
                  "qText": "value",
                  "qIsNumeric": true,
                  "qNumber": 123
                }
              ],
              "qPackedHashKeys": [
                123
              ]
            }
          ],
          "qObjectsLayout": [
            {
              "qId": "value",
              "qActive": true,
              "qShowMode": 123,
              "qScrollPos": {
                "qUsePosition": true,
                "qPos": {
                  "qx": 123,
                  "qy": 123
                }
              },
              "qExpansionInfo": [
                {
                  "qExcludeList": true,
                  "qPos": {
                    "qDimName": "value",
                    "qElemNo": [
                      123
                    ],
                    "qElemValues": [
                      "value"
                    ]
                  }
                }
              ],
              "qLeftCollapsed": true,
              "qTopCollapsed": true,
              "qSortData": [
                {
                  "qName": "value",
                  "qReversed": true
                }
              ],
              "qDimensionGroupPos": [
                {
                  "qGroupName": "value",
                  "qCurrentItemName": "value"
                }
              ],
              "qExpressionGroupPos": [
                {
                  "qGroupName": "value",
                  "qCurrentItemName": "value"
                }
              ],
              "qUseGraphMode": true,
              "qGraphMode": "GRAPH_MODE_BAR",
              "qActiveContainerChildObjectId": "value",
              "qExtendedPivotState": {
                "qExpressionPosition": 123,
                "qNumberOfLeftDimensions": 123,
                "qDimensionNames": [
                  "value"
                ],
                "qEnableConditions": [
                  "value"
                ]
              }
            }
          ],
          "qIncludeSelectionState": true,
          "qIncludeScrollPosition": true,
          "qAlternateStateData": [
            {
              "qStateName": "value",
              "qFieldItems": [
                {
                  "qDef": {
                    "qName": "value",
                    "qType": "NOT_PRESENT"
                  },
                  "qLocked": true,
                  "qSelectInfo": {
                    "qTextSearch": "value",
                    "qRangeLo": -1e+300,
                    "qRangeHi": -1e+300,
                    "qNumberFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qRangeInfo": [
                      {
                        "qRangeLo": -1e+300,
                        "qRangeHi": -1e+300,
                        "qMeasure": "value"
                      }
                    ],
                    "qSoftLock": false,
                    "qContinuousRangeInfo": [
                      {
                        "qMin": 123,
                        "qMax": 123,
                        "qMinInclEq": true,
                        "qMaxInclEq": true
                      }
                    ],
                    "qSelectFieldSearch": false
                  },
                  "qValues": [
                    {
                      "qText": "value",
                      "qIsNumeric": true,
                      "qNumber": 123
                    }
                  ],
                  "qExcludedValues": [
                    {
                      "qText": "value",
                      "qIsNumeric": true,
                      "qNumber": 123
                    }
                  ],
                  "qAndMode": true,
                  "qOneAndOnlyOne": true,
                  "qValuesCount": -1,
                  "qExcludedValuesCount": -1
                }
              ]
            }
          ],
          "qForAnnotations": true,
          "qIncludeAllVariables": false
        },
        "qClassicMetadata": {
          "qShared": true,
          "qUtcModifyTime": 123,
          "qSheetId": "value",
          "qTemporary": true,
          "qRestrictedAccess": true,
          "qAccessList": [
            "value"
          ],
          "qPersonalEditionHash_OBSOLETE": "value",
          "qHidden": false,
          "qLinkedTo": [
            "value"
          ]
        }
      }
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject SetGroupLabel

(qPath, qNewLabel, qTargetGroupId?)
Experimental

You can use the SetGroupLabel method with any object that contains an object grouping definition. This method allows you to change the label of an existing group of objects directly.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example /qNxGroupDef .

  • qNewLabel string
    Required

    New label for the group. A label starting with an '=' will be evaluated as an expression.

  • qTargetGroupId string

    Id of the group whose label will be set (if not the called object).

Response

object

Errors

array
GenericErrors

SetGroupLabel(qPath, qNewLabel, qTargetGroupId?)

enigma.js
const result = await genericObject.setGroupLabel("value", "value", "value")

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetGroupLabel",
  "params": {
    "qPath": "value",
    "qNewLabel": "value",
    "qTargetGroupId": "value"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject SetProperties

(qProp)

Sets some properties for a generic object.

The properties depends on the generic object type, see [properties](genericobject-property.html).

Parameters

  • qProp object
    Required

    Information about the generic object.

    Show qProp properties
    • qInfo object
      Show qInfo properties
      • qId string

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qType string

        Type of the object. This parameter is mandatory.
    • qExtendsId string

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDef object

      Used to collect metadata.

      Properties

      Semantic type with an empty structure.

    • qStateName string

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDef object

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qType string

        Type of the app list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDef object

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qIncludePatches boolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDef object

      Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

      Show qChildListDef properties
      • qData object

        Contains dynamic JSON data specified by the client.
    • qDimensionListDef object

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDef object

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDef object

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDef object

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystem boolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHidden boolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemantic boolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTables boolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnly boolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFields boolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicit boolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDef object

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qIncludeElemValue boolean
        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowTotal boolean
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
      • qMeasures array of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qInterColumnSortOrder array of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qInitialDataFetch array of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionMode string

        Can be one of: "N""D1""S""C""ST"

      • qMode string

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPos integer

        default = -1, format = int32, default = -1

      • qNoOfLeftDims integer

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpanded boolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCells integer

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAbove boolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentMode boolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCond object
        Show qCalcCond properties
        • qv string

          Expression evaluated to dual.
      • qSortbyYValue integer

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qColumnOrder array of integers

        The order of the columns.

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qDynamicScript array of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.

      • qSuppressMeasureTotals boolean

        When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
    • qLayoutExclude object

      Contains JSON to be excluded from validation.

    • qListObjectDef object

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qLibraryId string

        Refers to a dimension stored in the library.

      • qDef object
        Show qDef properties
        • qGrouping string

          Can be one of: "N""H""C"

        • qFieldDefs array of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabels array of strings

          Array of field labels. This parameter is optional.

        • qSortCriterias array of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qNumberPresentations array of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qType string

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDec integer

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThou integer

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmt string

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDec string

            Defines the decimal separator. Example: .

          • qThou string

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSort boolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveField integer

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpression string

          Label expression. This parameter is optional.

        • qAlias string

          Alias of the dimension.
      • qAutoSortByState object
        Show qAutoSortByState properties
        • qDisplayNumberOfRows integer

          This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyMode string

        Can be one of: "N""V""P""R"

      • qShowAlternatives boolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetch array of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeft integer

          Position from the left. Corresponds to the first column.

          format = int32

        • qTop integer

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidth integer

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeight integer

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressions array of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExpr string

          Value of the expression.

        • qLibraryId string

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedView boolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDef object

      Defines the list of measures.

      Show qMeasureListDef properties
      • qType string

        Type of the list.

      • qData object

        Contains dynamic JSON data specified by the client.
    • qMediaListDef object

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDef object
      Show qNxLibraryDimensionDef properties
      • qGrouping string

        Can be one of: "N""H""C"

      • qFieldDefs array of strings

        Array of dimension names.

      • qFieldLabels array of strings

        Array of dimension labels.

      • qLabelExpression string
      • qAlias string

        Alias of the dimension.

      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDef object
      Show qNxLibraryMeasureDef properties
      • qLabel string

        Label of the measure.

      • qDef string

        Definition of the measure.

      • qGrouping string

        Can be one of: "N""H""C"

      • qExpressions array of strings

        Array of expressions.

      • qActiveExpression integer

        Index to the active expression in a measure.

        format = int32

      • qLabelExpression string

        Optional expression used for dynamic label.

      • qNumFormat object

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qType string

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDec integer

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThou integer

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmt string

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDec string

          Defines the decimal separator. Example: .

        • qThou string

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGenerated boolean Deprecated

        default = false

      • qOrigin string

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDef object

      To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

      Properties

      "qSelectionObjectDef": {}

      Show qSelectionObjectDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDef object
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrl string

        Relative path of the thumbnail.
    • qStringExpression object

      Properties

      Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string
      The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      A string expression is not evaluated, if the expression is surrounded by simple quotes.
      The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
      Show qStringExpression properties
      • qExpr string
    • qTreeDataDef object

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateName string

        Name of the alternate state. Default is current selections $ .

      • qDimensions array of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryId string

          Refers to a dimension stored in the library.

        • qDef object
          Show qDef properties
          • qGrouping string

            Can be one of: "N""H""C"

          • qFieldDefs array of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabels array of strings

            Array of field labels. This parameter is optional.

          • qSortCriterias array of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qNumberPresentations array of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveField integer

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpression string

            Label expression. This parameter is optional.

          • qAlias string

            Alias of the dimension.
        • qValueExprs array of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryId string

            Refers to a measure stored in the library.

          • qDef object
            Show qDef properties
            • qLabel string

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescription string

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTags array of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGrouping string

              Can be one of: "N""H""C"

            • qDef string

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelative boolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSum boolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFunc string

              Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

            • qAccumulate integer
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSort boolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpression integer

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressions array of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpression string

              Label expression. This parameter is optional.
          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qAttributeDimensions array of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qAttribute boolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCond object
            Show qCalcCond properties
            • qv string

              Expression evaluated to dual.
          • qCalcCondition object
            Show qCalcCondition properties
            • qCond object
              Show qCond properties
              • qv string

                Expression evaluated to dual.
            • qMsg object
              Show qMsg properties
              • qv string

                Expression evaluated to string.
          • qTrendLines array of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qType string

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIx integer

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2 boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxis string

              Can be one of: "Never""Possible""Time"

            • qMultiDimMode string

              Can be one of: "Multi""Sum"

          • qMiniChartDef object
            Show qMiniChartDef properties
            • qDef string

              Expression or field name.

            • qLibraryId string

              LibraryId for dimension.

            • qSortBy object
              Show qSortBy properties
              • qSortByState integer

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequency integer

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumeric integer

                Sorts the field values by numeric value.

                format = int8

              • qSortByAscii integer

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrder integer

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpression integer

                Sorts the field by expression.

                format = int8

              • qExpression object
                Show qExpression properties
                • qv string

                  Expression evaluated to dual.
              • qSortByGreyness integer

                format = int8

            • qOtherTotalSpec object
              Show qOtherTotalSpec properties
              • qOtherMode string

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCounted object
                Show qOtherCounted properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimit object
                Show qOtherLimit properties
                • qv string

                  Expression evaluated to dual.
              • qOtherLimitMode string

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOther boolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeeping boolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResult boolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGrouping boolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensions boolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortMode string

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalMode string

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpression object
                Show qReferencedExpression properties
                • qv string

                  Expression evaluated to string.
            • qMaxNumberPoints integer

              default = -1, format = int32, default = -1

            • qAttributeExpressions array of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpression string

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryId string

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttribute boolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormat object

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qType string

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDec integer

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThou integer

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmt string

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDec string

                  Defines the decimal separator. Example: .

                • qThou string

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabel string

                Label of the attribute expression.

              • qLabelExpression string

                Optional expression used for dynamic label.
            • qNullSuppression boolean

              If set to true, no null values are returned.
        • qNullSuppression boolean

          If set to true, no null values are returned.

        • qOtherTotalSpec object
          Show qOtherTotalSpec properties
          • qOtherMode string

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCounted object
            Show qOtherCounted properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimit object
            Show qOtherLimit properties
            • qv string

              Expression evaluated to dual.
          • qOtherLimitMode string

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOther boolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeeping boolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResult boolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGrouping boolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensions boolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortMode string

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalMode string

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpression object
            Show qReferencedExpression properties
            • qv string

              Expression evaluated to string.
        • qShowAll boolean

          If set to true, all dimension values are shown.

        • qOtherLabel object
          Show qOtherLabel properties
          • qv string

            Expression evaluated to string.
        • qTotalLabel object
          Show qTotalLabel properties
          • qv string

            Expression evaluated to string.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrder array of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZero boolean

        Removes zero values.

        default = false

      • qSuppressMissing boolean

        Removes missing values.

        default = false

      • qOpenFullyExpanded boolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissing boolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qCalcCondition object
        Show qCalcCondition properties
        • qCond object
          Show qCond properties
          • qv string

            Expression evaluated to dual.
        • qMsg object
          Show qMsg properties
          • qv string

            Expression evaluated to string.
      • qTitle object
        Show qTitle properties
        • qv string

          Expression evaluated to string.
      • qInitialDataFetch array of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodes integer

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodes array of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qArea object
            Show qArea properties
            • qLeft integer

              Position from the left. Corresponds to the first column.

              format = int32

            • qTop integer

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidth integer

              Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

            • qHeight integer

              Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

          • qAllValues boolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevels object
          Show qTreeLevels properties
          • qLeft integer

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepth integer

            Number of dimensions to include in the tree.

            default = -1, format = int32, default = -1

      • qExpansionState array of objects
        Experimental

        Expansion state per dimension.

        Show qExpansionState properties
        • qExcludeList boolean
        • qPos object
          Show qPos properties
          • qDimName string
          • qElemNo array of integers
          • qElemValues array of strings
      • qValueExprs array of objects

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryId string

          Refers to a measure stored in the library.

        • qDef object
          Show qDef properties
          • qLabel string

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescription string

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTags array of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGrouping string

            Can be one of: "N""H""C"

          • qDef string

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelative boolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSum boolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFunc string

            Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.

          • qAccumulate integer
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSort boolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpression integer

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressions array of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpression string

            Label expression. This parameter is optional.
        • qSortBy object
          Show qSortBy properties
          • qSortByState integer

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequency integer

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumeric integer

            Sorts the field values by numeric value.

            format = int8

          • qSortByAscii integer

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrder integer

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpression integer

            Sorts the field by expression.

            format = int8

          • qExpression object
            Show qExpression properties
            • qv string

              Expression evaluated to dual.
          • qSortByGreyness integer

            format = int8

        • qAttributeExpressions array of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpression string

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryId string

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttribute boolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormat object

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qType string

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDec integer

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThou integer

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmt string

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDec string

              Defines the decimal separator. Example: .

            • qThou string

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabel string

            Label of the attribute expression.

          • qLabelExpression string

            Optional expression used for dynamic label.
        • qAttributeDimensions array of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qAttribute boolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCond object
          Show qCalcCond properties
          • qv string

            Expression evaluated to dual.
        • qCalcCondition object
          Show qCalcCondition properties
          • qCond object
            Show qCond properties
            • qv string

              Expression evaluated to dual.
          • qMsg object
            Show qMsg properties
            • qv string

              Expression evaluated to string.
        • qTrendLines array of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qType string

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIx integer

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2 boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxis string

            Can be one of: "Never""Possible""Time"

          • qMultiDimMode string

            Can be one of: "Multi""Sum"

        • qMiniChartDef object
          Show qMiniChartDef properties
          • qDef string

            Expression or field name.

          • qLibraryId string

            LibraryId for dimension.

          • qSortBy object
            Show qSortBy properties
            • qSortByState integer

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency integer

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumeric integer

              Sorts the field values by numeric value.

              format = int8

            • qSortByAscii integer

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrder integer

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpression integer

              Sorts the field by expression.

              format = int8

            • qExpression object
              Show qExpression properties
              • qv string

                Expression evaluated to dual.
            • qSortByGreyness integer

              format = int8

          • qOtherTotalSpec object
            Show qOtherTotalSpec properties
            • qOtherMode string

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCounted object
              Show qOtherCounted properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimit object
              Show qOtherLimit properties
              • qv string

                Expression evaluated to dual.
            • qOtherLimitMode string

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOther boolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeeping boolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResult boolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGrouping boolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensions boolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortMode string

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalMode string

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpression object
              Show qReferencedExpression properties
              • qv string

                Expression evaluated to string.
          • qMaxNumberPoints integer

            default = -1, format = int32, default = -1

          • qAttributeExpressions array of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpression string

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryId string

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttribute boolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormat object

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qType string

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDec integer

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThou integer

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmt string

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDec string

                Defines the decimal separator. Example: .

              • qThou string

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabel string

              Label of the attribute expression.

            • qLabelExpression string

              Optional expression used for dynamic label.
          • qNullSuppression boolean

            If set to true, no null values are returned.
      • qContextSetExpression string

        Set expression valid for the whole cube, limiting computations to the specified set.
    • qUndoInfoDef object

      Defines if an object should contain information on the number of possible undo and redo.

      Properties

      "qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

    • qValueExpression object

      Properties

      Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:

      • < expression > is a string.
      The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
      The expression is evaluated as a numeric.
      Show qValueExpression properties
      • qExpr string
    • qVariableListDef object

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qType string

        Type of variables to include in the list.

      • qShowReserved boolean

        Shows the reserved variables if set to true.

      • qShowConfig boolean

        Shows the system variables if set to true.

      • qData object

        Contains dynamic JSON data specified by the client.

      • qShowSession boolean

        Shows the session variables if set to true.
    Show additional optional properties
    • object object
      Private
      Any of:
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object
      • object

Response

object

Errors

array
GenericErrors

SetProperties(qProp)

enigma.js
const result = await genericObject.setProperties({
  "qInfo": {
    "qId": "value",
    "qType": "value"
  },
  "qExtendsId": "value",
  "qMetaDef": {},
  "qStateName": "value",
  "qAppObjectListDef": {
    "qType": "value",
    "qData": {}
  },
  "qBookmarkListDef": {
    "qType": "value",
    "qData": {},
    "qIncludePatches": true
  },
  "qChildListDef": {
    "qData": {}
  },
  "qDimensionListDef": {
    "qType": "value",
    "qData": {}
  },
  "qEmbeddedSnapshotDef": {},
  "qExtensionListDef": {},
  "qFieldListDef": {
    "qShowSystem": false,
    "qShowHidden": false,
    "qShowSemantic": false,
    "qShowSrcTables": false,
    "qShowDefinitionOnly": false,
    "qShowDerivedFields": false,
    "qShowImplicit": false
  },
  "qHyperCubeDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qNullSuppression": true,
        "qIncludeElemValue": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowTotal": true,
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCond": {
          "qv": "value"
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        }
      }
    ],
    "qMeasures": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qReductionMode": "N",
    "qMode": "S",
    "qPseudoDimPos": -1,
    "qNoOfLeftDims": -1,
    "qAlwaysFullyExpanded": false,
    "qMaxStackedCells": 5000,
    "qPopulateMissing": false,
    "qShowTotalsAbove": false,
    "qIndentMode": false,
    "qCalcCond": {
      "qv": "value"
    },
    "qSortbyYValue": 0,
    "qTitle": {
      "qv": "value"
    },
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qColumnOrder": [
      123
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qDynamicScript": [
      "value"
    ],
    "qContextSetExpression": "value",
    "qSuppressMeasureTotals": true
  },
  "qLayoutExclude": {},
  "qListObjectDef": {
    "qStateName": "value",
    "qLibraryId": "value",
    "qDef": {
      "qGrouping": "N",
      "qFieldDefs": [
        "value"
      ],
      "qFieldLabels": [
        "value"
      ],
      "qSortCriterias": [
        {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        }
      ],
      "qNumberPresentations": [
        {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        }
      ],
      "qReverseSort": true,
      "qActiveField": 123,
      "qLabelExpression": "value",
      "qAlias": "value"
    },
    "qAutoSortByState": {
      "qDisplayNumberOfRows": 123
    },
    "qFrequencyMode": "N",
    "qShowAlternatives": true,
    "qInitialDataFetch": [
      {
        "qLeft": 123,
        "qTop": 123,
        "qWidth": 123,
        "qHeight": 123
      }
    ],
    "qExpressions": [
      {
        "qExpr": "value",
        "qLibraryId": "value"
      }
    ],
    "qDirectQuerySimplifiedView": true
  },
  "qMeasureListDef": {
    "qType": "value",
    "qData": {}
  },
  "qMediaListDef": {},
  "qNxLibraryDimensionDef": {
    "qGrouping": "N",
    "qFieldDefs": [
      "value"
    ],
    "qFieldLabels": [
      "value"
    ],
    "qLabelExpression": "value",
    "qAlias": "value",
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qNxLibraryMeasureDef": {
    "qLabel": "value",
    "qDef": "value",
    "qGrouping": "N",
    "qExpressions": [
      "value"
    ],
    "qActiveExpression": 123,
    "qLabelExpression": "value",
    "qNumFormat": {
      "qType": "U",
      "qnDec": 10,
      "qUseThou": 0,
      "qFmt": "value",
      "qDec": "value",
      "qThou": "value"
    },
    "qScriptGenerated": false,
    "qOrigin": "PROGRAM"
  },
  "qSelectionObjectDef": {
    "qStateName": "value"
  },
  "qStaticContentUrlDef": {
    "qUrl": "value"
  },
  "qStringExpression": {
    "qExpr": "value"
  },
  "qTreeDataDef": {
    "qStateName": "value",
    "qDimensions": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qNullSuppression": true,
        "qOtherTotalSpec": {
          "qOtherMode": "OTHER_OFF",
          "qOtherCounted": {
            "qv": "value"
          },
          "qOtherLimit": {
            "qv": "value"
          },
          "qOtherLimitMode": "OTHER_GE_LIMIT",
          "qSuppressOther": false,
          "qForceBadValueKeeping": true,
          "qApplyEvenWhenPossiblyWrongResult": true,
          "qGlobalOtherGrouping": false,
          "qOtherCollapseInnerDimensions": false,
          "qOtherSortMode": "OTHER_SORT_DEFAULT",
          "qTotalMode": "TOTAL_OFF",
          "qReferencedExpression": {
            "qv": "value"
          }
        },
        "qShowAll": true,
        "qOtherLabel": {
          "qv": "value"
        },
        "qTotalLabel": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ]
      }
    ],
    "qInterColumnSortOrder": [
      123
    ],
    "qSuppressZero": false,
    "qSuppressMissing": false,
    "qOpenFullyExpanded": false,
    "qPopulateMissing": false,
    "qCalcCondition": {
      "qCond": {
        "qv": "value"
      },
      "qMsg": {
        "qv": "value"
      }
    },
    "qTitle": {
      "qv": "value"
    },
    "qInitialDataFetch": [
      {
        "qMaxNbrOfNodes": 123,
        "qTreeNodes": [
          {
            "qArea": {
              "qLeft": 123,
              "qTop": 123,
              "qWidth": 123,
              "qHeight": 123
            },
            "qAllValues": true
          }
        ],
        "qTreeLevels": {
          "qLeft": 123,
          "qDepth": -1
        }
      }
    ],
    "qExpansionState": [
      {
        "qExcludeList": true,
        "qPos": {
          "qDimName": "value",
          "qElemNo": [
            123
          ],
          "qElemValues": [
            "value"
          ]
        }
      }
    ],
    "qValueExprs": [
      {
        "qLibraryId": "value",
        "qDef": {
          "qLabel": "value",
          "qDescription": "value",
          "qTags": [
            "value"
          ],
          "qGrouping": "N",
          "qDef": "value",
          "qNumFormat": {
            "qType": "U",
            "qnDec": 10,
            "qUseThou": 0,
            "qFmt": "value",
            "qDec": "value",
            "qThou": "value"
          },
          "qRelative": true,
          "qBrutalSum": true,
          "qAggrFunc": "value",
          "qAccumulate": 123,
          "qReverseSort": true,
          "qActiveExpression": 123,
          "qExpressions": [
            "value"
          ],
          "qLabelExpression": "value"
        },
        "qSortBy": {
          "qSortByState": 123,
          "qSortByFrequency": 123,
          "qSortByNumeric": 123,
          "qSortByAscii": 123,
          "qSortByLoadOrder": 123,
          "qSortByExpression": 123,
          "qExpression": {
            "qv": "value"
          },
          "qSortByGreyness": 123
        },
        "qAttributeExpressions": [
          {
            "qExpression": "value",
            "qLibraryId": "value",
            "qAttribute": true,
            "qNumFormat": {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            },
            "qLabel": "value",
            "qLabelExpression": "value"
          }
        ],
        "qAttributeDimensions": [
          {
            "qDef": "value",
            "qLibraryId": "value",
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttribute": true
          }
        ],
        "qCalcCond": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTrendLines": [
          {
            "qType": "AVERAGE",
            "qXColIx": -1,
            "qCalcR2": false,
            "qContinuousXAxis": "Never",
            "qMultiDimMode": "Multi"
          }
        ],
        "qMiniChartDef": {
          "qDef": "value",
          "qLibraryId": "value",
          "qSortBy": {
            "qSortByState": 123,
            "qSortByFrequency": 123,
            "qSortByNumeric": 123,
            "qSortByAscii": 123,
            "qSortByLoadOrder": 123,
            "qSortByExpression": 123,
            "qExpression": {
              "qv": "value"
            },
            "qSortByGreyness": 123
          },
          "qOtherTotalSpec": {
            "qOtherMode": "OTHER_OFF",
            "qOtherCounted": {
              "qv": "value"
            },
            "qOtherLimit": {
              "qv": "value"
            },
            "qOtherLimitMode": "OTHER_GE_LIMIT",
            "qSuppressOther": false,
            "qForceBadValueKeeping": true,
            "qApplyEvenWhenPossiblyWrongResult": true,
            "qGlobalOtherGrouping": false,
            "qOtherCollapseInnerDimensions": false,
            "qOtherSortMode": "OTHER_SORT_DEFAULT",
            "qTotalMode": "TOTAL_OFF",
            "qReferencedExpression": {
              "qv": "value"
            }
          },
          "qMaxNumberPoints": -1,
          "qAttributeExpressions": [
            {
              "qExpression": "value",
              "qLibraryId": "value",
              "qAttribute": true,
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qLabel": "value",
              "qLabelExpression": "value"
            }
          ],
          "qNullSuppression": true
        }
      }
    ],
    "qContextSetExpression": "value"
  },
  "qUndoInfoDef": {},
  "qValueExpression": {
    "qExpr": "value"
  },
  "qVariableListDef": {
    "qType": "value",
    "qShowReserved": true,
    "qShowConfig": true,
    "qData": {},
    "qShowSession": true
  }
})

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "SetProperties",
  "params": {
    "qProp": {
      "qInfo": {
        "qId": "value",
        "qType": "value"
      },
      "qExtendsId": "value",
      "qMetaDef": {},
      "qStateName": "value",
      "qAppObjectListDef": {
        "qType": "value",
        "qData": {}
      },
      "qBookmarkListDef": {
        "qType": "value",
        "qData": {},
        "qIncludePatches": true
      },
      "qChildListDef": {
        "qData": {}
      },
      "qDimensionListDef": {
        "qType": "value",
        "qData": {}
      },
      "qEmbeddedSnapshotDef": {},
      "qExtensionListDef": {},
      "qFieldListDef": {
        "qShowSystem": false,
        "qShowHidden": false,
        "qShowSemantic": false,
        "qShowSrcTables": false,
        "qShowDefinitionOnly": false,
        "qShowDerivedFields": false,
        "qShowImplicit": false
      },
      "qHyperCubeDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qNullSuppression": true,
            "qIncludeElemValue": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowTotal": true,
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCond": {
              "qv": "value"
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            }
          }
        ],
        "qMeasures": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qReductionMode": "N",
        "qMode": "S",
        "qPseudoDimPos": -1,
        "qNoOfLeftDims": -1,
        "qAlwaysFullyExpanded": false,
        "qMaxStackedCells": 5000,
        "qPopulateMissing": false,
        "qShowTotalsAbove": false,
        "qIndentMode": false,
        "qCalcCond": {
          "qv": "value"
        },
        "qSortbyYValue": 0,
        "qTitle": {
          "qv": "value"
        },
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qColumnOrder": [
          123
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qDynamicScript": [
          "value"
        ],
        "qContextSetExpression": "value",
        "qSuppressMeasureTotals": true
      },
      "qLayoutExclude": {},
      "qListObjectDef": {
        "qStateName": "value",
        "qLibraryId": "value",
        "qDef": {
          "qGrouping": "N",
          "qFieldDefs": [
            "value"
          ],
          "qFieldLabels": [
            "value"
          ],
          "qSortCriterias": [
            {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            }
          ],
          "qNumberPresentations": [
            {
              "qType": "U",
              "qnDec": 10,
              "qUseThou": 0,
              "qFmt": "value",
              "qDec": "value",
              "qThou": "value"
            }
          ],
          "qReverseSort": true,
          "qActiveField": 123,
          "qLabelExpression": "value",
          "qAlias": "value"
        },
        "qAutoSortByState": {
          "qDisplayNumberOfRows": 123
        },
        "qFrequencyMode": "N",
        "qShowAlternatives": true,
        "qInitialDataFetch": [
          {
            "qLeft": 123,
            "qTop": 123,
            "qWidth": 123,
            "qHeight": 123
          }
        ],
        "qExpressions": [
          {
            "qExpr": "value",
            "qLibraryId": "value"
          }
        ],
        "qDirectQuerySimplifiedView": true
      },
      "qMeasureListDef": {
        "qType": "value",
        "qData": {}
      },
      "qMediaListDef": {},
      "qNxLibraryDimensionDef": {
        "qGrouping": "N",
        "qFieldDefs": [
          "value"
        ],
        "qFieldLabels": [
          "value"
        ],
        "qLabelExpression": "value",
        "qAlias": "value",
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qNxLibraryMeasureDef": {
        "qLabel": "value",
        "qDef": "value",
        "qGrouping": "N",
        "qExpressions": [
          "value"
        ],
        "qActiveExpression": 123,
        "qLabelExpression": "value",
        "qNumFormat": {
          "qType": "U",
          "qnDec": 10,
          "qUseThou": 0,
          "qFmt": "value",
          "qDec": "value",
          "qThou": "value"
        },
        "qScriptGenerated": false,
        "qOrigin": "PROGRAM"
      },
      "qSelectionObjectDef": {
        "qStateName": "value"
      },
      "qStaticContentUrlDef": {
        "qUrl": "value"
      },
      "qStringExpression": {
        "qExpr": "value"
      },
      "qTreeDataDef": {
        "qStateName": "value",
        "qDimensions": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qGrouping": "N",
              "qFieldDefs": [
                "value"
              ],
              "qFieldLabels": [
                "value"
              ],
              "qSortCriterias": [
                {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                }
              ],
              "qNumberPresentations": [
                {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                }
              ],
              "qReverseSort": true,
              "qActiveField": 123,
              "qLabelExpression": "value",
              "qAlias": "value"
            },
            "qValueExprs": [
              {
                "qLibraryId": "value",
                "qDef": {
                  "qLabel": "value",
                  "qDescription": "value",
                  "qTags": [
                    "value"
                  ],
                  "qGrouping": "N",
                  "qDef": "value",
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qRelative": true,
                  "qBrutalSum": true,
                  "qAggrFunc": "value",
                  "qAccumulate": 123,
                  "qReverseSort": true,
                  "qActiveExpression": 123,
                  "qExpressions": [
                    "value"
                  ],
                  "qLabelExpression": "value"
                },
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttributeExpressions": [
                  {
                    "qExpression": "value",
                    "qLibraryId": "value",
                    "qAttribute": true,
                    "qNumFormat": {
                      "qType": "U",
                      "qnDec": 10,
                      "qUseThou": 0,
                      "qFmt": "value",
                      "qDec": "value",
                      "qThou": "value"
                    },
                    "qLabel": "value",
                    "qLabelExpression": "value"
                  }
                ],
                "qAttributeDimensions": [
                  {
                    "qDef": "value",
                    "qLibraryId": "value",
                    "qSortBy": {
                      "qSortByState": 123,
                      "qSortByFrequency": 123,
                      "qSortByNumeric": 123,
                      "qSortByAscii": 123,
                      "qSortByLoadOrder": 123,
                      "qSortByExpression": 123,
                      "qExpression": {
                        "qv": "value"
                      },
                      "qSortByGreyness": 123
                    },
                    "qAttribute": true
                  }
                ],
                "qCalcCond": {
                  "qv": "value"
                },
                "qCalcCondition": {
                  "qCond": {
                    "qv": "value"
                  },
                  "qMsg": {
                    "qv": "value"
                  }
                },
                "qTrendLines": [
                  {
                    "qType": "AVERAGE",
                    "qXColIx": -1,
                    "qCalcR2": false,
                    "qContinuousXAxis": "Never",
                    "qMultiDimMode": "Multi"
                  }
                ],
                "qMiniChartDef": {
                  "qDef": "value",
                  "qLibraryId": "value",
                  "qSortBy": {
                    "qSortByState": 123,
                    "qSortByFrequency": 123,
                    "qSortByNumeric": 123,
                    "qSortByAscii": 123,
                    "qSortByLoadOrder": 123,
                    "qSortByExpression": 123,
                    "qExpression": {
                      "qv": "value"
                    },
                    "qSortByGreyness": 123
                  },
                  "qOtherTotalSpec": {
                    "qOtherMode": "OTHER_OFF",
                    "qOtherCounted": {
                      "qv": "value"
                    },
                    "qOtherLimit": {
                      "qv": "value"
                    },
                    "qOtherLimitMode": "OTHER_GE_LIMIT",
                    "qSuppressOther": false,
                    "qForceBadValueKeeping": true,
                    "qApplyEvenWhenPossiblyWrongResult": true,
                    "qGlobalOtherGrouping": false,
                    "qOtherCollapseInnerDimensions": false,
                    "qOtherSortMode": "OTHER_SORT_DEFAULT",
                    "qTotalMode": "TOTAL_OFF",
                    "qReferencedExpression": {
                      "qv": "value"
                    }
                  },
                  "qMaxNumberPoints": -1,
                  "qAttributeExpressions": [
                    {
                      "qExpression": "value",
                      "qLibraryId": "value",
                      "qAttribute": true,
                      "qNumFormat": {
                        "qType": "U",
                        "qnDec": 10,
                        "qUseThou": 0,
                        "qFmt": "value",
                        "qDec": "value",
                        "qThou": "value"
                      },
                      "qLabel": "value",
                      "qLabelExpression": "value"
                    }
                  ],
                  "qNullSuppression": true
                }
              }
            ],
            "qNullSuppression": true,
            "qOtherTotalSpec": {
              "qOtherMode": "OTHER_OFF",
              "qOtherCounted": {
                "qv": "value"
              },
              "qOtherLimit": {
                "qv": "value"
              },
              "qOtherLimitMode": "OTHER_GE_LIMIT",
              "qSuppressOther": false,
              "qForceBadValueKeeping": true,
              "qApplyEvenWhenPossiblyWrongResult": true,
              "qGlobalOtherGrouping": false,
              "qOtherCollapseInnerDimensions": false,
              "qOtherSortMode": "OTHER_SORT_DEFAULT",
              "qTotalMode": "TOTAL_OFF",
              "qReferencedExpression": {
                "qv": "value"
              }
            },
            "qShowAll": true,
            "qOtherLabel": {
              "qv": "value"
            },
            "qTotalLabel": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ]
          }
        ],
        "qInterColumnSortOrder": [
          123
        ],
        "qSuppressZero": false,
        "qSuppressMissing": false,
        "qOpenFullyExpanded": false,
        "qPopulateMissing": false,
        "qCalcCondition": {
          "qCond": {
            "qv": "value"
          },
          "qMsg": {
            "qv": "value"
          }
        },
        "qTitle": {
          "qv": "value"
        },
        "qInitialDataFetch": [
          {
            "qMaxNbrOfNodes": 123,
            "qTreeNodes": [
              {
                "qArea": {
                  "qLeft": 123,
                  "qTop": 123,
                  "qWidth": 123,
                  "qHeight": 123
                },
                "qAllValues": true
              }
            ],
            "qTreeLevels": {
              "qLeft": 123,
              "qDepth": -1
            }
          }
        ],
        "qExpansionState": [
          {
            "qExcludeList": true,
            "qPos": {
              "qDimName": "value",
              "qElemNo": [
                123
              ],
              "qElemValues": [
                "value"
              ]
            }
          }
        ],
        "qValueExprs": [
          {
            "qLibraryId": "value",
            "qDef": {
              "qLabel": "value",
              "qDescription": "value",
              "qTags": [
                "value"
              ],
              "qGrouping": "N",
              "qDef": "value",
              "qNumFormat": {
                "qType": "U",
                "qnDec": 10,
                "qUseThou": 0,
                "qFmt": "value",
                "qDec": "value",
                "qThou": "value"
              },
              "qRelative": true,
              "qBrutalSum": true,
              "qAggrFunc": "value",
              "qAccumulate": 123,
              "qReverseSort": true,
              "qActiveExpression": 123,
              "qExpressions": [
                "value"
              ],
              "qLabelExpression": "value"
            },
            "qSortBy": {
              "qSortByState": 123,
              "qSortByFrequency": 123,
              "qSortByNumeric": 123,
              "qSortByAscii": 123,
              "qSortByLoadOrder": 123,
              "qSortByExpression": 123,
              "qExpression": {
                "qv": "value"
              },
              "qSortByGreyness": 123
            },
            "qAttributeExpressions": [
              {
                "qExpression": "value",
                "qLibraryId": "value",
                "qAttribute": true,
                "qNumFormat": {
                  "qType": "U",
                  "qnDec": 10,
                  "qUseThou": 0,
                  "qFmt": "value",
                  "qDec": "value",
                  "qThou": "value"
                },
                "qLabel": "value",
                "qLabelExpression": "value"
              }
            ],
            "qAttributeDimensions": [
              {
                "qDef": "value",
                "qLibraryId": "value",
                "qSortBy": {
                  "qSortByState": 123,
                  "qSortByFrequency": 123,
                  "qSortByNumeric": 123,
                  "qSortByAscii": 123,
                  "qSortByLoadOrder": 123,
                  "qSortByExpression": 123,
                  "qExpression": {
                    "qv": "value"
                  },
                  "qSortByGreyness": 123
                },
                "qAttribute": true
              }
            ],
            "qCalcCond": {
              "qv": "value"
            },
            "qCalcCondition": {
              "qCond": {
                "qv": "value"
              },
              "qMsg": {
                "qv": "value"
              }
            },
            "qTrendLines": [
              {
                "qType": "AVERAGE",
                "qXColIx": -1,
                "qCalcR2": false,
                "qContinuousXAxis": "Never",
                "qMultiDimMode": "Multi"
              }
            ],
            "qMiniChartDef": {
              "qDef": "value",
              "qLibraryId": "value",
              "qSortBy": {
                "qSortByState": 123,
                "qSortByFrequency": 123,
                "qSortByNumeric": 123,
                "qSortByAscii": 123,
                "qSortByLoadOrder": 123,
                "qSortByExpression": 123,
                "qExpression": {
                  "qv": "value"
                },
                "qSortByGreyness": 123
              },
              "qOtherTotalSpec": {
                "qOtherMode": "OTHER_OFF",
                "qOtherCounted": {
                  "qv": "value"
                },
                "qOtherLimit": {
                  "qv": "value"
                },
                "qOtherLimitMode": "OTHER_GE_LIMIT",
                "qSuppressOther": false,
                "qForceBadValueKeeping": true,
                "qApplyEvenWhenPossiblyWrongResult": true,
                "qGlobalOtherGrouping": false,
                "qOtherCollapseInnerDimensions": false,
                "qOtherSortMode": "OTHER_SORT_DEFAULT",
                "qTotalMode": "TOTAL_OFF",
                "qReferencedExpression": {
                  "qv": "value"
                }
              },
              "qMaxNumberPoints": -1,
              "qAttributeExpressions": [
                {
                  "qExpression": "value",
                  "qLibraryId": "value",
                  "qAttribute": true,
                  "qNumFormat": {
                    "qType": "U",
                    "qnDec": 10,
                    "qUseThou": 0,
                    "qFmt": "value",
                    "qDec": "value",
                    "qThou": "value"
                  },
                  "qLabel": "value",
                  "qLabelExpression": "value"
                }
              ],
              "qNullSuppression": true
            }
          }
        ],
        "qContextSetExpression": "value"
      },
      "qUndoInfoDef": {},
      "qValueExpression": {
        "qExpr": "value"
      },
      "qVariableListDef": {
        "qType": "value",
        "qShowReserved": true,
        "qShowConfig": true,
        "qData": {},
        "qShowSession": true
      }
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject StepCycle

(qPath, qDimNo, qNbrSteps)
Experimental

You can use the StepCycle method with any object that contains a cyclic group as a dimension. This method allows you to move between different fields in a cyclic dimension. A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed.

Parameters

  • qPath string
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qDimNo integer
    Required

    Dimension number or index starting from 0. The default value is 0.

  • qNbrSteps integer
    Required

    Number of steps you want to cycle. Positive values cycle forwards while negative values cycle backwards. A value of 0 leads to no action being taken.

Response

object

Errors

array
GenericErrors

StepCycle(qPath, qDimNo, qNbrSteps)

enigma.js
const result = await genericObject.stepCycle("value", 123, 123)

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "StepCycle",
  "params": {
    "qPath": "value",
    "qDimNo": 123,
    "qNbrSteps": 123
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject UnApprove

()

Removes the generic object from the list of approved objects

This operation is possible only in Qlik Sense Enterprise.

Response

object

Errors

array
GenericErrors

UnApprove()

enigma.js
const result = await genericObject.unApprove()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "UnApprove"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject UnPublish

()

Unpublishes a generic object.

This operation is not applicable for Qlik Sense Desktop.

Response

object

Errors

array
GenericErrors

UnPublish()

enigma.js
const result = await genericObject.unPublish()

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "UnPublish"
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

GenericObject Unlock

(qPath, qColIndices?)

Unlocks the selected values of a generic object if the target (or handle ) is a generic object

Parameters

  • qPath string
    Required

    Path to the definition of the object. For example, /qListObjectDef .

  • qColIndices array of integers

    Dimension numbers/indexes where the unlock should apply. Dimension numbers/indexes start from 0. If this parameter is not set, the locked values in all dimensions are unlocked.

Response

object

Errors

array
GenericErrors

Unlock(qPath, qColIndices?)

enigma.js
const result = await genericObject.unlock("value", [
  123
])

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "handle": 3,
  "method": "Unlock",
  "params": {
    "qPath": "value",
    "qColIndices": [
      123
    ]
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}