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

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

  • qPathstring
    Required

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

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

  • qSoftLockboolean

    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

  • qPathstring
    Required

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

  • qMembersarray of objects
    RequiredExperimental

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

    Show qMembers properties
    • qGroupIdstring
    • qObjectIdstring
  • qTargetGroupIdstring

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

  • qPosIdstring

    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

  • qPatchesarray of objects
    Required

    Array of patches.

    Show qPatches properties
    • qOpstring

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

    • qPathstring

      Path to the property to add, remove or replace.

    • qValuestring

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

    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

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

  • qPathstring
    Required

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

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

  • qPathstring
    Required

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

  • qRowinteger
    Required

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

  • qColinteger
    Required

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

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

  • qPathstring
    Required

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

  • qRowinteger
    Required

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

  • qColinteger
    Required

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

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

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

  • qPropobject
    Required

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

    Show qProp properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

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

      • qTypestring

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

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

    • qMetaDefobject

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

    • qStateNamestring

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

    • qAppObjectListDefobject

      Defines the list of objects in an app.

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

        Type of the app list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDefobject

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qIncludePatchesboolean

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

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

        Contains dynamic JSON data specified by the client.
    • qDimensionListDefobject

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDefobject

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDefobject

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDefobject

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystemboolean

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

        default = false

      • qShowHiddenboolean

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

        default = false

      • qShowSemanticboolean

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

        default = false

      • qShowSrcTablesboolean

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

        default = false

      • qShowDefinitionOnlyboolean

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

        default = false

      • qShowDerivedFieldsboolean

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

        default = false

      • qShowImplicitboolean

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

        default = false

    • qHyperCubeDefobject

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

      Show qHyperCubeDef properties
      • qStateNamestring

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

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

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

          • qFieldDefsarray of strings

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

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

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

            Show qSortCriterias properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

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

            Show qNumberPresentations properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

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

          • qActiveFieldinteger

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

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qNullSuppressionboolean

          If set to true, no null values are returned.

        • qIncludeElemValueboolean
        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

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

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

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

              Expression evaluated to dual.
          • qOtherLimitModestring

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

          • qSuppressOtherboolean

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

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

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

            default = true

          • qGlobalOtherGroupingboolean

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

            default = false

          • qOtherCollapseInnerDimensionsboolean

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

            default = false

          • qOtherSortModestring

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

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowTotalboolean
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

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

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

            Expression evaluated to dual.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

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

          • qLibraryIdstring

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

          • qAttributeboolean

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

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

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

              Expression evaluated to string.
      • qMeasuresarray of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

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

          • qDescriptionstring

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

          • qTagsarray of strings

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

          • qGroupingstring

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

          • qDefstring

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

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

          • qBrutalSumboolean

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

          • qAggrFuncstring

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

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

            format = int32

          • qReverseSortboolean

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

          • qActiveExpressioninteger

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

            format = int32

          • qExpressionsarray of strings

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

          • qLabelExpressionstring

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

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

            format = int8

          • qSortByFrequencyinteger

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

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

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

          • qLibraryIdstring

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

          • qAttributeboolean

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

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

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

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

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

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

          • qXColIxinteger

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

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

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

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

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

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

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

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

                Expression evaluated to dual.
            • qOtherLimitModestring

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

            • qSuppressOtherboolean

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

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

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

              default = true

            • qGlobalOtherGroupingboolean

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

              default = false

            • qOtherCollapseInnerDimensionsboolean

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

              default = false

            • qOtherSortModestring

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

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

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

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

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

            • qLibraryIdstring

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

            • qAttributeboolean

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

            • qNumFormatobject

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

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

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

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

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

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

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

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qInitialDataFetcharray of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

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

          format = int32

        • qHeightinteger

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

          format = int32

      • qReductionModestring

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

      • qModestring

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

      • qPseudoDimPosinteger

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

      • qNoOfLeftDimsinteger

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

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

        implies that:

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

        Another example:

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

        Implies that:

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

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

      • qAlwaysFullyExpandedboolean

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

        default = false

      • qMaxStackedCellsinteger

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

        default = 5000, format = int32, default = 5000

      • qPopulateMissingboolean

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

        default = false

      • qShowTotalsAboveboolean

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

        default = false

      • qIndentModeboolean

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

        default = false

      • qCalcCondobject
        Show qCalcCond properties
        • qvstring

          Expression evaluated to dual.
      • qSortbyYValueinteger

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

        default = 0, format = int8, default = 0

      • qTitleobject
        Show qTitle properties
        • qvstring

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

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

            Expression evaluated to string.
      • qColumnOrderarray of integers

        The order of the columns.

      • qExpansionStatearray of objects
        Experimental

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

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

        Hypercube Modifier Dynamic script string

      • qContextSetExpressionstring

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

      • qSuppressMeasureTotalsboolean

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

      Contains JSON to be excluded from validation.

    • qListObjectDefobject

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

      Show qListObjectDef properties
      • qStateNamestring

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

      • qLibraryIdstring

        Refers to a dimension stored in the library.

      • qDefobject
        Show qDef properties
        • qGroupingstring

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

        • qFieldDefsarray of strings

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

        • qFieldLabelsarray of strings

          Array of field labels. This parameter is optional.

        • qSortCriteriasarray of objects

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

          Show qSortCriterias properties
          • qSortByStateinteger

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

            format = int8

          • qSortByFrequencyinteger

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

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qNumberPresentationsarray of objects

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

          Show qNumberPresentations properties
          • qTypestring

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

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

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

            default = 0, format = int32, default = 0

          • qFmtstring

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

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

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

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

        • qActiveFieldinteger

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

          format = int32

        • qLabelExpressionstring

          Label expression. This parameter is optional.

        • qAliasstring

          Alias of the dimension.
      • qAutoSortByStateobject
        Show qAutoSortByState properties
        • qDisplayNumberOfRowsinteger

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

          format = int32

      • qFrequencyModestring

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

      • qShowAlternativesboolean

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

      • qInitialDataFetcharray of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

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

          format = int32

        • qHeightinteger

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

          format = int32

      • qExpressionsarray of objects

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

        Show qExpressions properties
        • qExprstring

          Value of the expression.

        • qLibraryIdstring

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedViewboolean
        Experimental

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

      Defines the list of measures.

      Show qMeasureListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qMediaListDefobject

      Defines the list of media files.

      This struct is deprecated.

      Properties

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

    • qNxLibraryDimensionDefobject
      Show qNxLibraryDimensionDef properties
      • qGroupingstring

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

      • qFieldDefsarray of strings

        Array of dimension names.

      • qFieldLabelsarray of strings

        Array of dimension labels.

      • qLabelExpressionstring
      • qAliasstring

        Alias of the dimension.

      • qScriptGeneratedbooleanDeprecated

        default = false

      • qOriginstring

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

    • qNxLibraryMeasureDefobject
      Show qNxLibraryMeasureDef properties
      • qLabelstring

        Label of the measure.

      • qDefstring

        Definition of the measure.

      • qGroupingstring

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

      • qExpressionsarray of strings

        Array of expressions.

      • qActiveExpressioninteger

        Index to the active expression in a measure.

        format = int32

      • qLabelExpressionstring

        Optional expression used for dynamic label.

      • qNumFormatobject

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

        Formatting mechanism

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

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

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

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

        Type is INTEGER

        The following applies:

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

        Type is REAL

        The following applies:

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

        Type is FIX

        The following applies:

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

        Type is MONEY

        The following applies:

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

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

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

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        default = false

      • qOriginstring

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

    • qSelectionObjectDefobject

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

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

        Relative path of the thumbnail.
    • qStringExpressionobject

      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
      • qExprstring
    • qTreeDataDefobject

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

      Show qTreeDataDef properties
      • qStateNamestring

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

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

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

          • qFieldDefsarray of strings

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

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

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

            Show qSortCriterias properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

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

            Show qNumberPresentations properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

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

          • qActiveFieldinteger

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

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qValueExprsarray of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryIdstring

            Refers to a measure stored in the library.

          • qDefobject
            Show qDef properties
            • qLabelstring

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

            • qDescriptionstring

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

            • qTagsarray of strings

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

            • qGroupingstring

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

            • qDefstring

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

            • qNumFormatobject

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

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

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

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

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

            • qBrutalSumboolean

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

            • qAggrFuncstring

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

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

              format = int32

            • qReverseSortboolean

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

            • qActiveExpressioninteger

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

              format = int32

            • qExpressionsarray of strings

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

            • qLabelExpressionstring

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

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

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

            • qLibraryIdstring

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

            • qAttributeboolean

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

            • qNumFormatobject

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

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

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

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

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qAttributeDimensionsarray of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDefstring

              Expression or field name.

            • qLibraryIdstring

              LibraryId for dimension.

            • qSortByobject
              Show qSortBy properties
              • qSortByStateinteger

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

                format = int8

              • qSortByFrequencyinteger

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

                format = int8

              • qSortByNumericinteger

                Sorts the field values by numeric value.

                format = int8

              • qSortByAsciiinteger

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrderinteger

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpressioninteger

                Sorts the field by expression.

                format = int8

              • qExpressionobject
                Show qExpression properties
                • qvstring

                  Expression evaluated to dual.
              • qSortByGreynessinteger

                format = int8

            • qAttributeboolean

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

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

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

                Expression evaluated to string.
          • qTrendLinesarray of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qTypestring

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

            • qXColIxinteger

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

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

            • qCalcR2boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxisstring

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

            • qMultiDimModestring

              Can be one of: "Multi""Sum"

          • qMiniChartDefobject
            Show qMiniChartDef properties
            • qDefstring

              Expression or field name.

            • qLibraryIdstring

              LibraryId for dimension.

            • qSortByobject
              Show qSortBy properties
              • qSortByStateinteger

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

                format = int8

              • qSortByFrequencyinteger

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

                format = int8

              • qSortByNumericinteger

                Sorts the field values by numeric value.

                format = int8

              • qSortByAsciiinteger

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrderinteger

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpressioninteger

                Sorts the field by expression.

                format = int8

              • qExpressionobject
                Show qExpression properties
                • qvstring

                  Expression evaluated to dual.
              • qSortByGreynessinteger

                format = int8

            • qOtherTotalSpecobject
              Show qOtherTotalSpec properties
              • qOtherModestring

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

              • qOtherCountedobject
                Show qOtherCounted properties
                • qvstring

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

                  Expression evaluated to dual.
              • qOtherLimitModestring

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

              • qSuppressOtherboolean

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

                default = false

              • qForceBadValueKeepingboolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

                default = true

              • qApplyEvenWhenPossiblyWrongResultboolean

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

                default = true

              • qGlobalOtherGroupingboolean

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

                default = false

              • qOtherCollapseInnerDimensionsboolean

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

                default = false

              • qOtherSortModestring

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

              • qTotalModestring

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpressionobject
                Show qReferencedExpression properties
                • qvstring

                  Expression evaluated to string.
            • qMaxNumberPointsinteger

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

            • qAttributeExpressionsarray of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpressionstring

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

              • qLibraryIdstring

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

              • qAttributeboolean

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

              • qNumFormatobject

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

                Formatting mechanism

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

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

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

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

                Type is INTEGER

                The following applies:

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

                Type is REAL

                The following applies:

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

                Type is FIX

                The following applies:

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

                Type is MONEY

                The following applies:

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

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qTypestring

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

                • qnDecinteger

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThouinteger

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

                  default = 0, format = int32, default = 0

                • qFmtstring

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

                • qDecstring

                  Defines the decimal separator. Example: .

                • qThoustring

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

                Label of the attribute expression.

              • qLabelExpressionstring

                Optional expression used for dynamic label.
            • qNullSuppressionboolean

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

          If set to true, no null values are returned.

        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

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

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

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

              Expression evaluated to dual.
          • qOtherLimitModestring

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

          • qSuppressOtherboolean

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

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

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

            default = true

          • qGlobalOtherGroupingboolean

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

            default = false

          • qOtherCollapseInnerDimensionsboolean

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

            default = false

          • qOtherSortModestring

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

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

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

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

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

              Expression evaluated to string.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

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

          • qLibraryIdstring

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

          • qAttributeboolean

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

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

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

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qOpenFullyExpandedboolean

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

        default = false

      • qPopulateMissingboolean

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

        default = false

      • qCalcConditionobject
        Show qCalcCondition properties
        • qCondobject
          Show qCond properties
          • qvstring

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

            Expression evaluated to string.
      • qTitleobject
        Show qTitle properties
        • qvstring

          Expression evaluated to string.
      • qInitialDataFetcharray of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodesinteger

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

          format = int32

        • qTreeNodesarray of objects

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

          Show qTreeNodes properties
          • qAreaobject
            Show qArea properties
            • qLeftinteger

              Position from the left. Corresponds to the first column.

              format = int32

            • qTopinteger

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidthinteger

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

              format = int32

            • qHeightinteger

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

              format = int32

          • qAllValuesboolean

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

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

            format = int32

          • qDepthinteger

            Number of dimensions to include in the tree.

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

      • qExpansionStatearray of objects
        Experimental

        Expansion state per dimension.

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

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

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

          • qDescriptionstring

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

          • qTagsarray of strings

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

          • qGroupingstring

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

          • qDefstring

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

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

          • qBrutalSumboolean

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

          • qAggrFuncstring

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

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

            format = int32

          • qReverseSortboolean

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

          • qActiveExpressioninteger

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

            format = int32

          • qExpressionsarray of strings

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

          • qLabelExpressionstring

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

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

            format = int8

          • qSortByFrequencyinteger

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

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

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

          • qLibraryIdstring

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

          • qAttributeboolean

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

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

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

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

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

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

          • qXColIxinteger

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

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

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

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

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

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

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

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

                Expression evaluated to dual.
            • qOtherLimitModestring

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

            • qSuppressOtherboolean

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

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

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

              default = true

            • qGlobalOtherGroupingboolean

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

              default = false

            • qOtherCollapseInnerDimensionsboolean

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

              default = false

            • qOtherSortModestring

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

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

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

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

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

            • qLibraryIdstring

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

            • qAttributeboolean

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

            • qNumFormatobject

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

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

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

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

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

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

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

      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.

    • qValueExpressionobject

      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
      • qExprstring
    • qVariableListDefobject

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qTypestring

        Type of variables to include in the list.

      • qShowReservedboolean

        Shows the reserved variables if set to true.

      • qShowConfigboolean

        Shows the system variables if set to true.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qShowSessionboolean

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

    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
    • qInfoobject
      Show qInfo properties
      • qIdstring

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

      • qTypestring

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

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

    • qMetaDefobject

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

    • qStateNamestring

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

    • qAppObjectListDefobject

      Defines the list of objects in an app.

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

        Type of the app list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDefobject

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qIncludePatchesboolean

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

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

        Contains dynamic JSON data specified by the client.
    • qDimensionListDefobject

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDefobject

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDefobject

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDefobject

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystemboolean

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

        default = false

      • qShowHiddenboolean

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

        default = false

      • qShowSemanticboolean

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

        default = false

      • qShowSrcTablesboolean

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

        default = false

      • qShowDefinitionOnlyboolean

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

        default = false

      • qShowDerivedFieldsboolean

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

        default = false

      • qShowImplicitboolean

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

        default = false

    • qHyperCubeDefobject

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

      Show qHyperCubeDef properties
      • qStateNamestring

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

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

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

          • qFieldDefsarray of strings

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

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

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

            Show qSortCriterias properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

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

            Show qNumberPresentations properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

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

          • qActiveFieldinteger

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

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qNullSuppressionboolean

          If set to true, no null values are returned.

        • qIncludeElemValueboolean
        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

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

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

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

              Expression evaluated to dual.
          • qOtherLimitModestring

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

          • qSuppressOtherboolean

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

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

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

            default = true

          • qGlobalOtherGroupingboolean

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

            default = false

          • qOtherCollapseInnerDimensionsboolean

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

            default = false

          • qOtherSortModestring

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

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowTotalboolean
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

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

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

            Expression evaluated to dual.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

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

          • qLibraryIdstring

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

          • qAttributeboolean

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

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

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

              Expression evaluated to string.
      • qMeasuresarray of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

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

          • qDescriptionstring

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

          • qTagsarray of strings

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

          • qGroupingstring

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

          • qDefstring

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

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

          • qBrutalSumboolean

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

          • qAggrFuncstring

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

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

            format = int32

          • qReverseSortboolean

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

          • qActiveExpressioninteger

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

            format = int32

          • qExpressionsarray of strings

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

          • qLabelExpressionstring

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

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

            format = int8

          • qSortByFrequencyinteger

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

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

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

          • qLibraryIdstring

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

          • qAttributeboolean

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

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

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

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

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

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

          • qXColIxinteger

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

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

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

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

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

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

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

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

                Expression evaluated to dual.
            • qOtherLimitModestring

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

            • qSuppressOtherboolean

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

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

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

              default = true

            • qGlobalOtherGroupingboolean

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

              default = false

            • qOtherCollapseInnerDimensionsboolean

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

              default = false

            • qOtherSortModestring

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

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

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

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

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

            • qLibraryIdstring

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

            • qAttributeboolean

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

            • qNumFormatobject

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

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

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

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

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

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

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

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qInitialDataFetcharray of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

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

          format = int32

        • qHeightinteger

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

          format = int32

      • qReductionModestring

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

      • qModestring

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

      • qPseudoDimPosinteger

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

      • qNoOfLeftDimsinteger

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

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

        implies that:

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

        Another example:

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

        Implies that:

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

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

      • qAlwaysFullyExpandedboolean

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

        default = false

      • qMaxStackedCellsinteger

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

        default = 5000, format = int32, default = 5000

      • qPopulateMissingboolean

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

        default = false

      • qShowTotalsAboveboolean

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

        default = false

      • qIndentModeboolean

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

        default = false

      • qCalcCondobject
        Show qCalcCond properties
        • qvstring

          Expression evaluated to dual.
      • qSortbyYValueinteger

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

        default = 0, format = int8, default = 0

      • qTitleobject
        Show qTitle properties
        • qvstring

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

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

            Expression evaluated to string.
      • qColumnOrderarray of integers

        The order of the columns.

      • qExpansionStatearray of objects
        Experimental

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

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

        Hypercube Modifier Dynamic script string

      • qContextSetExpressionstring

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

      • qSuppressMeasureTotalsboolean

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

      Contains JSON to be excluded from validation.

    • qListObjectDefobject

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

      Show qListObjectDef properties
      • qStateNamestring

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

      • qLibraryIdstring

        Refers to a dimension stored in the library.

      • qDefobject
        Show qDef properties
        • qGroupingstring

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

        • qFieldDefsarray of strings

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

        • qFieldLabelsarray of strings

          Array of field labels. This parameter is optional.

        • qSortCriteriasarray of objects

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

          Show qSortCriterias properties
          • qSortByStateinteger

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

            format = int8

          • qSortByFrequencyinteger

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

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qNumberPresentationsarray of objects

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

          Show qNumberPresentations properties
          • qTypestring

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

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

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

            default = 0, format = int32, default = 0

          • qFmtstring

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

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

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

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

        • qActiveFieldinteger

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

          format = int32

        • qLabelExpressionstring

          Label expression. This parameter is optional.

        • qAliasstring

          Alias of the dimension.
      • qAutoSortByStateobject
        Show qAutoSortByState properties
        • qDisplayNumberOfRowsinteger

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

          format = int32

      • qFrequencyModestring

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

      • qShowAlternativesboolean

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

      • qInitialDataFetcharray of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

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

          format = int32

        • qHeightinteger

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

          format = int32

      • qExpressionsarray of objects

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

        Show qExpressions properties
        • qExprstring

          Value of the expression.

        • qLibraryIdstring

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedViewboolean
        Experimental

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

      Defines the list of measures.

      Show qMeasureListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qMediaListDefobject

      Defines the list of media files.

      This struct is deprecated.

      Properties

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

    • qNxLibraryDimensionDefobject
      Show qNxLibraryDimensionDef properties
      • qGroupingstring

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

      • qFieldDefsarray of strings

        Array of dimension names.

      • qFieldLabelsarray of strings

        Array of dimension labels.

      • qLabelExpressionstring
      • qAliasstring

        Alias of the dimension.

      • qScriptGeneratedbooleanDeprecated

        default = false

      • qOriginstring

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

    • qNxLibraryMeasureDefobject
      Show qNxLibraryMeasureDef properties
      • qLabelstring

        Label of the measure.

      • qDefstring

        Definition of the measure.

      • qGroupingstring

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

      • qExpressionsarray of strings

        Array of expressions.

      • qActiveExpressioninteger

        Index to the active expression in a measure.

        format = int32

      • qLabelExpressionstring

        Optional expression used for dynamic label.

      • qNumFormatobject

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

        Formatting mechanism

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

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

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

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

        Type is INTEGER

        The following applies:

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

        Type is REAL

        The following applies:

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

        Type is FIX

        The following applies:

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

        Type is MONEY

        The following applies:

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

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qTypestring

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

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

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

          default = 0, format = int32, default = 0

        • qFmtstring

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

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

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

        default = false

      • qOriginstring

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

    • qSelectionObjectDefobject

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

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

        Relative path of the thumbnail.
    • qStringExpressionobject

      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
      • qExprstring
    • qTreeDataDefobject

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

      Show qTreeDataDef properties
      • qStateNamestring

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

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

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

          • qFieldDefsarray of strings

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

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

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

            Show qSortCriterias properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

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

            Show qNumberPresentations properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

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

          • qActiveFieldinteger

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

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qValueExprsarray of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryIdstring

            Refers to a measure stored in the library.

          • qDefobject
            Show qDef properties
            • qLabelstring

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

            • qDescriptionstring

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

            • qTagsarray of strings

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

            • qGroupingstring

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

            • qDefstring

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

            • qNumFormatobject

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

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

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

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

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

            • qBrutalSumboolean

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

            • qAggrFuncstring

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

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

              format = int32

            • qReverseSortboolean

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

            • qActiveExpressioninteger

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

              format = int32

            • qExpressionsarray of strings

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

            • qLabelExpressionstring

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

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

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

            • qLibraryIdstring

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

            • qAttributeboolean

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

            • qNumFormatobject

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

              Formatting mechanism

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

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

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

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

              Type is INTEGER

              The following applies:

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

              Type is REAL

              The following applies:

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

              Type is FIX

              The following applies:

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

              Type is MONEY

              The following applies:

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

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

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

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

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

                default = 0, format = int32, default = 0

              • qFmtstring

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

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

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

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qAttributeDimensionsarray of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDefstring

              Expression or field name.

            • qLibraryIdstring

              LibraryId for dimension.

            • qSortByobject
              Show qSortBy properties
              • qSortByStateinteger

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

                format = int8

              • qSortByFrequencyinteger

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

                format = int8

              • qSortByNumericinteger

                Sorts the field values by numeric value.

                format = int8

              • qSortByAsciiinteger

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrderinteger

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpressioninteger

                Sorts the field by expression.

                format = int8

              • qExpressionobject
                Show qExpression properties
                • qvstring

                  Expression evaluated to dual.
              • qSortByGreynessinteger

                format = int8

            • qAttributeboolean

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

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

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

                Expression evaluated to string.
          • qTrendLinesarray of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qTypestring

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

            • qXColIxinteger

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

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

            • qCalcR2boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxisstring

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

            • qMultiDimModestring

              Can be one of: "Multi""Sum"

          • qMiniChartDefobject
            Show qMiniChartDef properties
            • qDefstring

              Expression or field name.

            • qLibraryIdstring

              LibraryId for dimension.

            • qSortByobject
              Show qSortBy properties
              • qSortByStateinteger

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

                format = int8

              • qSortByFrequencyinteger

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

                format = int8

              • qSortByNumericinteger

                Sorts the field values by numeric value.

                format = int8

              • qSortByAsciiinteger

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrderinteger

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpressioninteger

                Sorts the field by expression.

                format = int8

              • qExpressionobject
                Show qExpression properties
                • qvstring

                  Expression evaluated to dual.
              • qSortByGreynessinteger

                format = int8

            • qOtherTotalSpecobject
              Show qOtherTotalSpec properties
              • qOtherModestring

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

              • qOtherCountedobject
                Show qOtherCounted properties
                • qvstring

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

                  Expression evaluated to dual.
              • qOtherLimitModestring

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

              • qSuppressOtherboolean

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

                default = false

              • qForceBadValueKeepingboolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

                default = true

              • qApplyEvenWhenPossiblyWrongResultboolean

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

                default = true

              • qGlobalOtherGroupingboolean

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

                default = false

              • qOtherCollapseInnerDimensionsboolean

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

                default = false

              • qOtherSortModestring

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

              • qTotalModestring

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpressionobject
                Show qReferencedExpression properties
                • qvstring

                  Expression evaluated to string.
            • qMaxNumberPointsinteger

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

            • qAttributeExpressionsarray of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpressionstring

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

              • qLibraryIdstring

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

              • qAttributeboolean

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

              • qNumFormatobject

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

                Formatting mechanism

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

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

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

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

                Type is INTEGER

                The following applies:

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

                Type is REAL

                The following applies:

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

                Type is FIX

                The following applies:

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

                Type is MONEY

                The following applies:

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

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qTypestring

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

                • qnDecinteger

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThouinteger

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

                  default = 0, format = int32, default = 0

                • qFmtstring

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

                • qDecstring

                  Defines the decimal separator. Example: .

                • qThoustring

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

                Label of the attribute expression.

              • qLabelExpressionstring

                Optional expression used for dynamic label.
            • qNullSuppressionboolean

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

          If set to true, no null values are returned.

        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

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

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

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

              Expression evaluated to dual.
          • qOtherLimitModestring

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

          • qSuppressOtherboolean

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

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

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

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

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

            default = true

          • qGlobalOtherGroupingboolean

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

            default = false

          • qOtherCollapseInnerDimensionsboolean

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

            default = false

          • qOtherSortModestring

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

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

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

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

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

              Expression evaluated to string.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

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

          • qLibraryIdstring

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

          • qAttributeboolean

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

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

              format = int8

            • qSortByFrequencyinteger

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

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

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

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

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qOpenFullyExpandedboolean

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

        default = false

      • qPopulateMissingboolean

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

        default = false

      • qCalcConditionobject
        Show qCalcCondition properties
        • qCondobject
          Show qCond properties
          • qvstring

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

            Expression evaluated to string.
      • qTitleobject
        Show qTitle properties
        • qvstring

          Expression evaluated to string.
      • qInitialDataFetcharray of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodesinteger

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

          format = int32

        • qTreeNodesarray of objects

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

          Show qTreeNodes properties
          • qAreaobject
            Show qArea properties
            • qLeftinteger

              Position from the left. Corresponds to the first column.

              format = int32

            • qTopinteger

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidthinteger

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

              format = int32

            • qHeightinteger

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

              format = int32

          • qAllValuesboolean

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

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

            format = int32

          • qDepthinteger

            Number of dimensions to include in the tree.

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

      • qExpansionStatearray of objects
        Experimental

        Expansion state per dimension.

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

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

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

          • qDescriptionstring

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

          • qTagsarray of strings

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

          • qGroupingstring

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

          • qDefstring

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

          • qNumFormatobject

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

            Formatting mechanism

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

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

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

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

            Type is INTEGER

            The following applies:

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

            Type is REAL

            The following applies:

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

            Type is FIX

            The following applies:

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

            Type is MONEY

            The following applies:

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

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

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

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

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

              default = 0, format = int32, default = 0

            • qFmtstring

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

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

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

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

          • qBrutalSumboolean

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

          • qAggrFuncstring

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

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

            format = int32

          • qReverseSortboolean

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

          • qActiveExpressioninteger

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

            format = int32

          • qExpressionsarray of strings

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

          • qLabelExpressionstring

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

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

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIxinteger

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

            Can be one of: "Never""Possible""Time"

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitobject
              Show qOtherLimit properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitModestring

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOtherboolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGroupingboolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensionsboolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortModestring

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

            default = -1, format = int32, default = -1

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryIdstring

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttributeboolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabelstring

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

            If set to true, no null values are returned.
      • qContextSetExpressionstring

        Set Expression valid for the whole cube. Used to limit computations to the set specified.
    • qUndoInfoDefobject

      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.

    • qValueExpressionobject

      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
      • qExprstring
    • qVariableListDefobject

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qTypestring

        Type of variables to include in the list.

      • qShowReservedboolean

        Shows the reserved variables if set to true.

      • qShowConfigboolean

        Shows the system variables if set to true.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qShowSessionboolean

        Shows the session variables if set to true.
    Show additional optional properties
    • objectobject
      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

  • qInfoobject
    Show qInfo properties
    • qIdstring

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qTypestring

      Type of the object. This parameter is mandatory.
  • qReturnobject
    Show qReturn properties
    • qTypestring

      The native type of the object.

    • qHandleinteger

      The handle used to connect to object.

      format = int32

    • qGenericTypestring

      The type of the object.

    • qGenericIdstring

      Object ID.

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

  • qPathstring
    Required

    Path to the definition of the object to be selected. For example /qNxGroupDef .

  • qGroupDefobject
    RequiredExperimental

    Definition of the new group.

    Show qGroupDef properties
    • qClassstring

      Can be one of: "bookmark""object"

    • qObjectTypestring

      Specifies the type of the group's object members.

      default = "bookmark"

    • qGroupTypestring

      Specifies the type of the group's subgroup members.

      default = "objectgroup"

    • qLabelstring

      The group's label. Will be evaluated as an expression if it starts with '='.

    • qIncludeOrphanGroupsboolean

      Include all groups of the relevant type, by adding those groups last that are not explicitly included in the hierarchy (orphans)

    • qMemberIdsarray of objects
      Experimental

      The objects and sub-groups that are members of the group.

      Show qMemberIds properties
      • qGroupIdstring
      • qObjectIdstring
  • qTargetGroupIdstring

    Id of the group to create the new subgroup in (if not the called object).

Response

  • qGroupIdstring

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

  • qPropForThisobject

    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
    • qInfoobject
      Show qInfo properties
      • qIdstring

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qExtendsIdstring

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDefobject

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

    • qStateNamestring

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDefobject

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qTypestring

        Type of the app list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDefobject

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qIncludePatchesboolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDefobject

      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
      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qDimensionListDefobject

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDefobject

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDefobject

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDefobject

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystemboolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHiddenboolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemanticboolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTablesboolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnlyboolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFieldsboolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicitboolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDefobject

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

            Can be one of: "N""H""C"

          • qFieldDefsarray of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveFieldinteger

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qNullSuppressionboolean

          If set to true, no null values are returned.

        • qIncludeElemValueboolean
        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitobject
            Show qOtherLimit properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitModestring

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOtherboolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGroupingboolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensionsboolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortModestring

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowTotalboolean
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

            Expression evaluated to string.
        • qTotalLabelobject
          Show qTotalLabel properties
          • qvstring

            Expression evaluated to string.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
      • qMeasuresarray of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescriptionstring

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTagsarray of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGroupingstring

            Can be one of: "N""H""C"

          • qDefstring

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelativeboolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSumboolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFuncstring

            Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

          • qAccumulateinteger
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpressioninteger

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressionsarray of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpressionstring

            Label expression. This parameter is optional.
        • qSortByobject
          Show qSortBy properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIxinteger

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

            Can be one of: "Never""Possible""Time"

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitobject
              Show qOtherLimit properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitModestring

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOtherboolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGroupingboolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensionsboolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortModestring

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

            default = -1, format = int32, default = -1

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryIdstring

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttributeboolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabelstring

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

            If set to true, no null values are returned.
      • qInterColumnSortOrderarray of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qInitialDataFetcharray of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeightinteger

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionModestring

        Can be one of: "N""D1""S""C""ST"

      • qModestring

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPosinteger

        default = -1, format = int32, default = -1

      • qNoOfLeftDimsinteger

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpandedboolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCellsinteger

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissingboolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAboveboolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentModeboolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCondobject
        Show qCalcCond properties
        • qvstring

          Expression evaluated to dual.
      • qSortbyYValueinteger

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitleobject
        Show qTitle properties
        • qvstring

          Expression evaluated to string.
      • qCalcConditionobject
        Show qCalcCondition properties
        • qCondobject
          Show qCond properties
          • qvstring

            Expression evaluated to dual.
        • qMsgobject
          Show qMsg properties
          • qvstring

            Expression evaluated to string.
      • qColumnOrderarray of integers

        The order of the columns.

      • qExpansionStatearray of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeListboolean
        • qPosobject
          Show qPos properties
          • qDimNamestring
          • qElemNoarray of integers
          • qElemValuesarray of strings
      • qDynamicScriptarray of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpressionstring

        Set Expression valid for the whole cube. Used to limit computations to the set specified.

      • qSuppressMeasureTotalsboolean

        If set to true, suppress any measure grand totals, ignoring any AggrFunc.
    • qLayoutExcludeobject

      Contains JSON to be excluded from validation.

    • qListObjectDefobject

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qLibraryIdstring

        Refers to a dimension stored in the library.

      • qDefobject
        Show qDef properties
        • qGroupingstring

          Can be one of: "N""H""C"

        • qFieldDefsarray of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabelsarray of strings

          Array of field labels. This parameter is optional.

        • qSortCriteriasarray of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qNumberPresentationsarray of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSortboolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveFieldinteger

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpressionstring

          Label expression. This parameter is optional.

        • qAliasstring

          Alias of the dimension.
      • qAutoSortByStateobject
        Show qAutoSortByState properties
        • qDisplayNumberOfRowsinteger

          This parameter applies to list objects. If the total number of values in the list object is greater than the value set in qDisplayNumberOfRows , the selected lines are promoted at the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyModestring

        Can be one of: "N""V""P""R"

      • qShowAlternativesboolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetcharray of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeightinteger

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressionsarray of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExprstring

          Value of the expression.

        • qLibraryIdstring

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedViewboolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDefobject

      Defines the list of measures.

      Show qMeasureListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qMediaListDefobject

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDefobject
      Show qNxLibraryDimensionDef properties
      • qGroupingstring

        Can be one of: "N""H""C"

      • qFieldDefsarray of strings

        Array of dimension names.

      • qFieldLabelsarray of strings

        Array of dimension labels.

      • qLabelExpressionstring
      • qAliasstring

        Alias of the dimension.

      • qScriptGeneratedbooleanDeprecated

        default = false

      • qOriginstring

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDefobject
      Show qNxLibraryMeasureDef properties
      • qLabelstring

        Label of the measure.

      • qDefstring

        Definition of the measure.

      • qGroupingstring

        Can be one of: "N""H""C"

      • qExpressionsarray of strings

        Array of expressions.

      • qActiveExpressioninteger

        Index to the active expression in a measure.

        format = int32

      • qLabelExpressionstring

        Optional expression used for dynamic label.

      • qNumFormatobject

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGeneratedbooleanDeprecated

        default = false

      • qOriginstring

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDefobject

      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
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDefobject
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrlstring

        Relative path of the thumbnail.
    • qStringExpressionobject

      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
      • qExprstring
    • qTreeDataDefobject

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

            Can be one of: "N""H""C"

          • qFieldDefsarray of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveFieldinteger

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qValueExprsarray of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryIdstring

            Refers to a measure stored in the library.

          • qDefobject
            Show qDef properties
            • qLabelstring

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescriptionstring

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTagsarray of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGroupingstring

              Can be one of: "N""H""C"

            • qDefstring

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelativeboolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSumboolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFuncstring

              Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

            • qAccumulateinteger
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSortboolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpressioninteger

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressionsarray of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpressionstring

              Label expression. This parameter is optional.
          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryIdstring

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttributeboolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabelstring

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qAttributeDimensionsarray of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDefstring

              Expression or field name.

            • qLibraryIdstring

              LibraryId for dimension.

            • qSortByobject
              Show qSortBy properties
              • qSortByStateinteger

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequencyinteger

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumericinteger

                Sorts the field values by numeric value.

                format = int8

              • qSortByAsciiinteger

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrderinteger

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpressioninteger

                Sorts the field by expression.

                format = int8

              • qExpressionobject
                Show qExpression properties
                • qvstring

                  Expression evaluated to dual.
              • qSortByGreynessinteger

                format = int8

            • qAttributeboolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCondobject
            Show qCalcCond properties
            • qvstring

              Expression evaluated to dual.
          • qCalcConditionobject
            Show qCalcCondition properties
            • qCondobject
              Show qCond properties
              • qvstring

                Expression evaluated to dual.
            • qMsgobject
              Show qMsg properties
              • qvstring

                Expression evaluated to string.
          • qTrendLinesarray of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qTypestring

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIxinteger

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxisstring

              Can be one of: "Never""Possible""Time"

            • qMultiDimModestring

              Can be one of: "Multi""Sum"

          • qMiniChartDefobject
            Show qMiniChartDef properties
            • qDefstring

              Expression or field name.

            • qLibraryIdstring

              LibraryId for dimension.

            • qSortByobject
              Show qSortBy properties
              • qSortByStateinteger

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequencyinteger

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumericinteger

                Sorts the field values by numeric value.

                format = int8

              • qSortByAsciiinteger

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrderinteger

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpressioninteger

                Sorts the field by expression.

                format = int8

              • qExpressionobject
                Show qExpression properties
                • qvstring

                  Expression evaluated to dual.
              • qSortByGreynessinteger

                format = int8

            • qOtherTotalSpecobject
              Show qOtherTotalSpec properties
              • qOtherModestring

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCountedobject
                Show qOtherCounted properties
                • qvstring

                  Expression evaluated to dual.
              • qOtherLimitobject
                Show qOtherLimit properties
                • qvstring

                  Expression evaluated to dual.
              • qOtherLimitModestring

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOtherboolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeepingboolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResultboolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGroupingboolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensionsboolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortModestring

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalModestring

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpressionobject
                Show qReferencedExpression properties
                • qvstring

                  Expression evaluated to string.
            • qMaxNumberPointsinteger

              default = -1, format = int32, default = -1

            • qAttributeExpressionsarray of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpressionstring

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryIdstring

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttributeboolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormatobject

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qTypestring

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDecinteger

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThouinteger

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmtstring

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDecstring

                  Defines the decimal separator. Example: .

                • qThoustring

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabelstring

                Label of the attribute expression.

              • qLabelExpressionstring

                Optional expression used for dynamic label.
            • qNullSuppressionboolean

              If set to true, no null values are returned.
        • qNullSuppressionboolean

          If set to true, no null values are returned.

        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitobject
            Show qOtherLimit properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitModestring

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOtherboolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGroupingboolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensionsboolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortModestring

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

            Expression evaluated to string.
        • qTotalLabelobject
          Show qTotalLabel properties
          • qvstring

            Expression evaluated to string.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrderarray of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qOpenFullyExpandedboolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissingboolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qCalcConditionobject
        Show qCalcCondition properties
        • qCondobject
          Show qCond properties
          • qvstring

            Expression evaluated to dual.
        • qMsgobject
          Show qMsg properties
          • qvstring

            Expression evaluated to string.
      • qTitleobject
        Show qTitle properties
        • qvstring

          Expression evaluated to string.
      • qInitialDataFetcharray of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodesinteger

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodesarray of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qAreaobject
            Show qArea properties
            • qLeftinteger

              Position from the left. Corresponds to the first column.

              format = int32

            • qTopinteger

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidthinteger

              Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

            • qHeightinteger

              Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

          • qAllValuesboolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevelsobject
          Show qTreeLevels properties
          • qLeftinteger

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepthinteger

            Number of dimensions to include in the tree.

            default = -1, format = int32, default = -1

      • qExpansionStatearray of objects
        Experimental

        Expansion state per dimension.

        Show qExpansionState properties
        • qExcludeListboolean
        • qPosobject
          Show qPos properties
          • qDimNamestring
          • qElemNoarray of integers
          • qElemValuesarray of strings
      • qValueExprsarray of objects

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescriptionstring

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTagsarray of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGroupingstring

            Can be one of: "N""H""C"

          • qDefstring

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelativeboolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSumboolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFuncstring

            Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

          • qAccumulateinteger
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpressioninteger

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressionsarray of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpressionstring

            Label expression. This parameter is optional.
        • qSortByobject
          Show qSortBy properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIxinteger

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

            Can be one of: "Never""Possible""Time"

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitobject
              Show qOtherLimit properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitModestring

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOtherboolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGroupingboolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensionsboolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortModestring

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

            default = -1, format = int32, default = -1

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryIdstring

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttributeboolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabelstring

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

            If set to true, no null values are returned.
      • qContextSetExpressionstring

        Set Expression valid for the whole cube. Used to limit computations to the set specified.
    • qUndoInfoDefobject

      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.

    • qValueExpressionobject

      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
      • qExprstring
    • qVariableListDefobject

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qTypestring

        Type of variables to include in the list.

      • qShowReservedboolean

        Shows the reserved variables if set to true.

      • qShowConfigboolean

        Shows the system variables if set to true.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qShowSessionboolean

        Shows the session variables if set to true.
    Show additional optional properties
    • objectobject
      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

  • qIdstring
    Required

    Identifier of the child to remove.

  • qPropForThisobject

    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
    • qInfoobject
      Show qInfo properties
      • qIdstring

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qExtendsIdstring

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDefobject

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

    • qStateNamestring

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDefobject

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qTypestring

        Type of the app list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDefobject

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qIncludePatchesboolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDefobject

      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
      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qDimensionListDefobject

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDefobject

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDefobject

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDefobject

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystemboolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHiddenboolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemanticboolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTablesboolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnlyboolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFieldsboolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicitboolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDefobject

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

            Can be one of: "N""H""C"

          • qFieldDefsarray of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveFieldinteger

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qNullSuppressionboolean

          If set to true, no null values are returned.

        • qIncludeElemValueboolean
        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitobject
            Show qOtherLimit properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitModestring

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOtherboolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGroupingboolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensionsboolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortModestring

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowTotalboolean
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

            Expression evaluated to string.
        • qTotalLabelobject
          Show qTotalLabel properties
          • qvstring

            Expression evaluated to string.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
      • qMeasuresarray of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescriptionstring

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTagsarray of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGroupingstring

            Can be one of: "N""H""C"

          • qDefstring

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelativeboolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSumboolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFuncstring

            Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

          • qAccumulateinteger
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpressioninteger

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressionsarray of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpressionstring

            Label expression. This parameter is optional.
        • qSortByobject
          Show qSortBy properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIxinteger

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

            Can be one of: "Never""Possible""Time"

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitobject
              Show qOtherLimit properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitModestring

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOtherboolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGroupingboolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensionsboolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortModestring

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

            default = -1, format = int32, default = -1

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryIdstring

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttributeboolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabelstring

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

            If set to true, no null values are returned.
      • qInterColumnSortOrderarray of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qInitialDataFetcharray of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeightinteger

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionModestring

        Can be one of: "N""D1""S""C""ST"

      • qModestring

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPosinteger

        default = -1, format = int32, default = -1

      • qNoOfLeftDimsinteger

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpandedboolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCellsinteger

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissingboolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAboveboolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentModeboolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCondobject
        Show qCalcCond properties
        • qvstring

          Expression evaluated to dual.
      • qSortbyYValueinteger

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitleobject
        Show qTitle properties
        • qvstring

          Expression evaluated to string.
      • qCalcConditionobject
        Show qCalcCondition properties
        • qCondobject
          Show qCond properties
          • qvstring

            Expression evaluated to dual.
        • qMsgobject
          Show qMsg properties
          • qvstring

            Expression evaluated to string.
      • qColumnOrderarray of integers

        The order of the columns.

      • qExpansionStatearray of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeListboolean
        • qPosobject
          Show qPos properties
          • qDimNamestring
          • qElemNoarray of integers
          • qElemValuesarray of strings
      • qDynamicScriptarray of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpressionstring

        Set Expression valid for the whole cube. Used to limit computations to the set specified.

      • qSuppressMeasureTotalsboolean

        If set to true, suppress any measure grand totals, ignoring any AggrFunc.
    • qLayoutExcludeobject

      Contains JSON to be excluded from validation.

    • qListObjectDefobject

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qLibraryIdstring

        Refers to a dimension stored in the library.

      • qDefobject
        Show qDef properties
        • qGroupingstring

          Can be one of: "N""H""C"

        • qFieldDefsarray of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabelsarray of strings

          Array of field labels. This parameter is optional.

        • qSortCriteriasarray of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qNumberPresentationsarray of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSortboolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveFieldinteger

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpressionstring

          Label expression. This parameter is optional.

        • qAliasstring

          Alias of the dimension.
      • qAutoSortByStateobject
        Show qAutoSortByState properties
        • qDisplayNumberOfRowsinteger

          This parameter applies to list objects. If the total number of values in the list object is greater than the value set in qDisplayNumberOfRows , the selected lines are promoted at the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyModestring

        Can be one of: "N""V""P""R"

      • qShowAlternativesboolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetcharray of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeightinteger

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressionsarray of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExprstring

          Value of the expression.

        • qLibraryIdstring

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedViewboolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDefobject

      Defines the list of measures.

      Show qMeasureListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qMediaListDefobject

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDefobject
      Show qNxLibraryDimensionDef properties
      • qGroupingstring

        Can be one of: "N""H""C"

      • qFieldDefsarray of strings

        Array of dimension names.

      • qFieldLabelsarray of strings

        Array of dimension labels.

      • qLabelExpressionstring
      • qAliasstring

        Alias of the dimension.

      • qScriptGeneratedbooleanDeprecated

        default = false

      • qOriginstring

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDefobject
      Show qNxLibraryMeasureDef properties
      • qLabelstring

        Label of the measure.

      • qDefstring

        Definition of the measure.

      • qGroupingstring

        Can be one of: "N""H""C"

      • qExpressionsarray of strings

        Array of expressions.

      • qActiveExpressioninteger

        Index to the active expression in a measure.

        format = int32

      • qLabelExpressionstring

        Optional expression used for dynamic label.

      • qNumFormatobject

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGeneratedbooleanDeprecated

        default = false

      • qOriginstring

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDefobject

      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
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDefobject
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrlstring

        Relative path of the thumbnail.
    • qStringExpressionobject

      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
      • qExprstring
    • qTreeDataDefobject

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

            Can be one of: "N""H""C"

          • qFieldDefsarray of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveFieldinteger

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qValueExprsarray of objects

          List of measures.

          Show qValueExprs properties
          • qLibraryIdstring

            Refers to a measure stored in the library.

          • qDefobject
            Show qDef properties
            • qLabelstring

              Name of the measure. An empty string is returned as a default value. This parameter is optional.

            • qDescriptionstring

              Description of the measure. An empty string is returned as a default value. This parameter is optional.

            • qTagsarray of strings

              Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

            • qGroupingstring

              Can be one of: "N""H""C"

            • qDefstring

              Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qRelativeboolean

              If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

            • qBrutalSumboolean

              If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

            • qAggrFuncstring

              Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

            • qAccumulateinteger
              • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

              format = int32

            • qReverseSortboolean

              If set to true, it inverts the sort criteria in the field.

            • qActiveExpressioninteger

              Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

              format = int32

            • qExpressionsarray of strings

              Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

            • qLabelExpressionstring

              Label expression. This parameter is optional.
          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryIdstring

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttributeboolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabelstring

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qAttributeDimensionsarray of objects

            List of attribute dimensions.

            Show qAttributeDimensions properties
            • qDefstring

              Expression or field name.

            • qLibraryIdstring

              LibraryId for dimension.

            • qSortByobject
              Show qSortBy properties
              • qSortByStateinteger

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequencyinteger

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumericinteger

                Sorts the field values by numeric value.

                format = int8

              • qSortByAsciiinteger

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrderinteger

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpressioninteger

                Sorts the field by expression.

                format = int8

              • qExpressionobject
                Show qExpression properties
                • qvstring

                  Expression evaluated to dual.
              • qSortByGreynessinteger

                format = int8

            • qAttributeboolean

              If set to true, this attribute will not affect the number of rows in the cube.
          • qCalcCondobject
            Show qCalcCond properties
            • qvstring

              Expression evaluated to dual.
          • qCalcConditionobject
            Show qCalcCondition properties
            • qCondobject
              Show qCond properties
              • qvstring

                Expression evaluated to dual.
            • qMsgobject
              Show qMsg properties
              • qvstring

                Expression evaluated to string.
          • qTrendLinesarray of objects
            Experimental

            Specifies trendlines for this measure.

            Show qTrendLines properties
            • qTypestring

              Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

            • qXColIxinteger

              The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

              default = -1, format = int32, default = -1

            • qCalcR2boolean

              Set to true to calulatate the R2 score

              default = false

            • qContinuousXAxisstring

              Can be one of: "Never""Possible""Time"

            • qMultiDimModestring

              Can be one of: "Multi""Sum"

          • qMiniChartDefobject
            Show qMiniChartDef properties
            • qDefstring

              Expression or field name.

            • qLibraryIdstring

              LibraryId for dimension.

            • qSortByobject
              Show qSortBy properties
              • qSortByStateinteger

                Sorts the field values according to their logical state (selected, optional, alternative or excluded).

                format = int8

              • qSortByFrequencyinteger

                Sorts the field values by frequency (number of occurrences in the field).

                format = int8

              • qSortByNumericinteger

                Sorts the field values by numeric value.

                format = int8

              • qSortByAsciiinteger

                Sorts the field by alphabetical order.

                format = int8

              • qSortByLoadOrderinteger

                Sorts the field values by the initial load order.

                format = int8

              • qSortByExpressioninteger

                Sorts the field by expression.

                format = int8

              • qExpressionobject
                Show qExpression properties
                • qvstring

                  Expression evaluated to dual.
              • qSortByGreynessinteger

                format = int8

            • qOtherTotalSpecobject
              Show qOtherTotalSpec properties
              • qOtherModestring

                Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

              • qOtherCountedobject
                Show qOtherCounted properties
                • qvstring

                  Expression evaluated to dual.
              • qOtherLimitobject
                Show qOtherLimit properties
                • qvstring

                  Expression evaluated to dual.
              • qOtherLimitModestring

                Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

              • qSuppressOtherboolean

                If set to true, the group Others is not displayed as a dimension value. The default value is false.

                default = false

              • qForceBadValueKeepingboolean

                This parameter is used when qOtherMode is set to:

                • OTHER_ABS_LIMITED
                • OTHER_REL_LIMITED
                • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

                and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

                default = true

              • qApplyEvenWhenPossiblyWrongResultboolean

                Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

                default = true

              • qGlobalOtherGroupingboolean

                This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

                default = false

              • qOtherCollapseInnerDimensionsboolean

                If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

                default = false

              • qOtherSortModestring

                Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

              • qTotalModestring

                Can be one of: "TOTAL_OFF""TOTAL_EXPR"

              • qReferencedExpressionobject
                Show qReferencedExpression properties
                • qvstring

                  Expression evaluated to string.
            • qMaxNumberPointsinteger

              default = -1, format = int32, default = -1

            • qAttributeExpressionsarray of objects

              List of attribute expressions.

              Show qAttributeExpressions properties
              • qExpressionstring

                Definition of the attribute expression. Example: "Max(OrderID)"

              • qLibraryIdstring

                Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

              • qAttributeboolean

                If set to true, this measure will not affect the number of rows in the cube.

              • qNumFormatobject

                Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

                Formatting mechanism

                The formatting mechanism depends on the type set in qType, as shown below:

                In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

                Type is DATE, TIME, TIMESTAMP or INTERVAL

                The following applies:

                • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
                • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
                • The properties qDec , qThou , qnDec , qUseThou are not used.

                Type is INTEGER

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

                Type is REAL

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
                • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
                • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is FIX

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
                • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

                Type is MONEY

                The following applies:

                • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
                • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

                Type is ASCII

                No formatting, qFmt is ignored.

                Show qNumFormat properties
                • qTypestring

                  Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

                • qnDecinteger

                  Number of decimals. Default is 10.

                  default = 10, format = int32, default = 10

                • qUseThouinteger

                  Defines whether or not a thousands separator must be used. Default is 0.

                  default = 0, format = int32, default = 0

                • qFmtstring

                  Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

                • qDecstring

                  Defines the decimal separator. Example: .

                • qThoustring

                  Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
              • qLabelstring

                Label of the attribute expression.

              • qLabelExpressionstring

                Optional expression used for dynamic label.
            • qNullSuppressionboolean

              If set to true, no null values are returned.
        • qNullSuppressionboolean

          If set to true, no null values are returned.

        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitobject
            Show qOtherLimit properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitModestring

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOtherboolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGroupingboolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensionsboolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortModestring

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

            Expression evaluated to string.
        • qTotalLabelobject
          Show qTotalLabel properties
          • qvstring

            Expression evaluated to string.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
      • qInterColumnSortOrderarray of integers

        Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qOpenFullyExpandedboolean

        If this property is set to true, the cells are opened expanded. The default value is false.

        default = false

      • qPopulateMissingboolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qCalcConditionobject
        Show qCalcCondition properties
        • qCondobject
          Show qCond properties
          • qvstring

            Expression evaluated to dual.
        • qMsgobject
          Show qMsg properties
          • qvstring

            Expression evaluated to string.
      • qTitleobject
        Show qTitle properties
        • qvstring

          Expression evaluated to string.
      • qInitialDataFetcharray of objects

        Initial data set. This property is optional.

        Show qInitialDataFetch properties
        • qMaxNbrOfNodesinteger

          Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.

          format = int32

        • qTreeNodesarray of objects

          Defines areas of the tree to be fetched. Areas must be defined left to right.

          Show qTreeNodes properties
          • qAreaobject
            Show qArea properties
            • qLeftinteger

              Position from the left. Corresponds to the first column.

              format = int32

            • qTopinteger

              Position from the top. Corresponds to the first row.

              format = int32

            • qWidthinteger

              Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

            • qHeightinteger

              Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

              format = int32

          • qAllValuesboolean

            When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
        • qTreeLevelsobject
          Show qTreeLevels properties
          • qLeftinteger

            The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.

            format = int32

          • qDepthinteger

            Number of dimensions to include in the tree.

            default = -1, format = int32, default = -1

      • qExpansionStatearray of objects
        Experimental

        Expansion state per dimension.

        Show qExpansionState properties
        • qExcludeListboolean
        • qPosobject
          Show qPos properties
          • qDimNamestring
          • qElemNoarray of integers
          • qElemValuesarray of strings
      • qValueExprsarray of objects

        List of measures to calculate on the whole tree.

        Show qValueExprs properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescriptionstring

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTagsarray of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGroupingstring

            Can be one of: "N""H""C"

          • qDefstring

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelativeboolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSumboolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFuncstring

            Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

          • qAccumulateinteger
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpressioninteger

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressionsarray of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpressionstring

            Label expression. This parameter is optional.
        • qSortByobject
          Show qSortBy properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIxinteger

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

            Can be one of: "Never""Possible""Time"

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitobject
              Show qOtherLimit properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitModestring

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOtherboolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGroupingboolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensionsboolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortModestring

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

            default = -1, format = int32, default = -1

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryIdstring

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttributeboolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabelstring

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

            If set to true, no null values are returned.
      • qContextSetExpressionstring

        Set Expression valid for the whole cube. Used to limit computations to the set specified.
    • qUndoInfoDefobject

      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.

    • qValueExpressionobject

      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
      • qExprstring
    • qVariableListDefobject

      Defines the list of variables in an app.

      Show qVariableListDef properties
      • qTypestring

        Type of variables to include in the list.

      • qShowReservedboolean

        Shows the reserved variables if set to true.

      • qShowConfigboolean

        Shows the system variables if set to true.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qShowSessionboolean

        Shows the session variables if set to true.
    Show additional optional properties
    • objectobject
      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

  • qSuccessboolean

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

  • qPathstring
    Required

    Path to the definition of the object to be selected. For example, /qHyperCubeDef .

  • qDimNointeger
    Required

    Dimension number or index starting from 0. The default value is 0.

  • qNbrStepsinteger
    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

  • qIdstring
    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

  • qAcceptboolean
    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

  • qPathstring
    Required

    Path to the definition of the object to be expanded. For example, /qHyperCubeDef .

  • qRowinteger
    Required

    Row index in the data matrix to expand. Indexing starts from 0.

  • qColinteger
    Required

    Column index. The index is based on the left dimension indexes. Indexing starts from 0.

  • qAllboolean
    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

  • qPathstring
    Required

    Path to the definition of the object to be expanded. For example, /qHyperCubeDef .

  • qRowinteger
    Required

    Row index. The index is based on the top dimension indexes. Indexing starts from 0.

  • qColinteger
    Required

    Column index in the data matrix. Indexing starts from 0.

  • qAllboolean
    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:

  • 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.
  • 16384 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:

  • 1000 to export to a CSV file

Default limitations in number of cells

The default maximum number of cells in the export file is:

  • 5000000 to export to a CSV file

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, then an out-of-memory 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

  • qFileTypestring
    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
  • qPathstring

    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 .

  • qFileNamestring

    Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop.

  • qExportStatestring

    Defines the values to be exported. The default value is A.

    One of:

    • P or EXPORT_POSSIBLE
    • A or EXPORT_ALL
  • qServeOnceboolean

    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

  • qUrlstring
  • qWarningsarray 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

  • qIdstring
    Required

    Identifier of the object.

Response

  • qReturnobject
    Show qReturn properties
    • qTypestring

      The native type of the object.

    • qHandleinteger

      The handle used to connect to object.

      format = int32

    • qGenericTypestring

      The type of the object.

    • qGenericIdstring

      Object ID.

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

  • qInfosarray of objects
    Show qInfos properties
    • qIdstring

      Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

    • qTypestring

      Type of the object. This parameter is mandatory.

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

  • qPropobject
    Show qProp properties
    • qInfoobject
      Show qInfo properties
      • qIdstring

        Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.

      • qTypestring

        Type of the object. This parameter is mandatory.
    • qExtendsIdstring

      Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

    • qMetaDefobject

      Used to collect meta data.

      Properties

      Semantic type with an empty structure.

    • qStateNamestring

      Name of the alternate state. Default is current selections $ .

    • qAppObjectListDefobject

      Defines the list of objects in an app.

      An app object is a generic object created at app level.
      Show qAppObjectListDef properties
      • qTypestring

        Type of the app list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qBookmarkListDefobject

      Defines the list of bookmarks.

      Show qBookmarkListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.

      • qIncludePatchesboolean

        Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
    • qChildListDefobject

      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
      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qDimensionListDefobject

      Defines the lists of dimensions.

      Show qDimensionListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qEmbeddedSnapshotDefobject

      Defines the embedded snapshot in a generic object.

      Properties

      "EmbeddedSnapshotDef": {}

    • qExtensionListDefobject

      Obsolete, use qrs API's to fetch extensions.

    • qFieldListDefobject

      Defines the fields to show.

      Show qFieldListDef properties
      • qShowSystemboolean

        Shows the system tables if set to true. Default is false.

        default = false

      • qShowHiddenboolean

        Shows the hidden fields if set to true. Default is false.

        default = false

      • qShowSemanticboolean

        Show the semantic fields if set to true. Default is false.

        default = false

      • qShowSrcTablesboolean

        Shows the tables and fields present in the data model viewer if set to true. Default is false.

        default = false

      • qShowDefinitionOnlyboolean

        Shows the fields defined on the fly if set to true. Default is false.

        default = false

      • qShowDerivedFieldsboolean

        Shows the fields and derived fields if set to true. Default is false.

        default = false

      • qShowImplicitboolean

        Shows the Direct Discovery measure fields if set to true. Default is false.

        default = false

    • qHyperCubeDefobject

      Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.

      Show qHyperCubeDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

            Can be one of: "N""H""C"

          • qFieldDefsarray of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qNumberPresentationsarray of objects

            Defines the format of the value. This parameter is optional.

            Show qNumberPresentations properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveFieldinteger

            Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

            format = int32

          • qLabelExpressionstring

            Label expression. This parameter is optional.

          • qAliasstring

            Alias of the dimension.
        • qNullSuppressionboolean

          If set to true, no null values are returned.

        • qIncludeElemValueboolean
        • qOtherTotalSpecobject
          Show qOtherTotalSpec properties
          • qOtherModestring

            Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

          • qOtherCountedobject
            Show qOtherCounted properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitobject
            Show qOtherLimit properties
            • qvstring

              Expression evaluated to dual.
          • qOtherLimitModestring

            Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

          • qSuppressOtherboolean

            If set to true, the group Others is not displayed as a dimension value. The default value is false.

            default = false

          • qForceBadValueKeepingboolean

            This parameter is used when qOtherMode is set to:

            • OTHER_ABS_LIMITED
            • OTHER_REL_LIMITED
            • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

            and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

            default = true

          • qApplyEvenWhenPossiblyWrongResultboolean

            Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

            default = true

          • qGlobalOtherGroupingboolean

            This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

            default = false

          • qOtherCollapseInnerDimensionsboolean

            If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

            default = false

          • qOtherSortModestring

            Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

          • qTotalModestring

            Can be one of: "TOTAL_OFF""TOTAL_EXPR"

          • qReferencedExpressionobject
            Show qReferencedExpression properties
            • qvstring

              Expression evaluated to string.
        • qShowTotalboolean
        • qShowAllboolean

          If set to true, all dimension values are shown.

        • qOtherLabelobject
          Show qOtherLabel properties
          • qvstring

            Expression evaluated to string.
        • qTotalLabelobject
          Show qTotalLabel properties
          • qvstring

            Expression evaluated to string.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
      • qMeasuresarray of objects

        Array of measures.

        Show qMeasures properties
        • qLibraryIdstring

          Refers to a measure stored in the library.

        • qDefobject
          Show qDef properties
          • qLabelstring

            Name of the measure. An empty string is returned as a default value. This parameter is optional.

          • qDescriptionstring

            Description of the measure. An empty string is returned as a default value. This parameter is optional.

          • qTagsarray of strings

            Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.

          • qGroupingstring

            Can be one of: "N""H""C"

          • qDefstring

            Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qRelativeboolean

            If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.

          • qBrutalSumboolean

            If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .

          • qAggrFuncstring

            Flag indicating how the measure should be aggregated to create a grand total. "None" - No total calculation. "Expr" - Calculate total according to the measure expression. "" - Empty string is default and has same effect as "Expr". This parameter is optional.

          • qAccumulateinteger
            • 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.

            format = int32

          • qReverseSortboolean

            If set to true, it inverts the sort criteria in the field.

          • qActiveExpressioninteger

            Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional.

            format = int32

          • qExpressionsarray of strings

            Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.

          • qLabelExpressionstring

            Label expression. This parameter is optional.
        • qSortByobject
          Show qSortBy properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qAttributeExpressionsarray of objects

          List of attribute expressions.

          Show qAttributeExpressions properties
          • qExpressionstring

            Definition of the attribute expression. Example: "Max(OrderID)"

          • qLibraryIdstring

            Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

          • qAttributeboolean

            If set to true, this measure will not affect the number of rows in the cube.

          • qNumFormatobject

            Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

            Formatting mechanism

            The formatting mechanism depends on the type set in qType, as shown below:

            In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

            Type is DATE, TIME, TIMESTAMP or INTERVAL

            The following applies:

            • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
            • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
            • The properties qDec , qThou , qnDec , qUseThou are not used.

            Type is INTEGER

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

            Type is REAL

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
            • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
            • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is FIX

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
            • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

            Type is MONEY

            The following applies:

            • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
            • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

            Type is ASCII

            No formatting, qFmt is ignored.

            Show qNumFormat properties
            • qTypestring

              Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

            • qnDecinteger

              Number of decimals. Default is 10.

              default = 10, format = int32, default = 10

            • qUseThouinteger

              Defines whether or not a thousands separator must be used. Default is 0.

              default = 0, format = int32, default = 0

            • qFmtstring

              Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

            • qDecstring

              Defines the decimal separator. Example: .

            • qThoustring

              Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
          • qLabelstring

            Label of the attribute expression.

          • qLabelExpressionstring

            Optional expression used for dynamic label.
        • qAttributeDimensionsarray of objects

          List of attribute dimensions.

          Show qAttributeDimensions properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qAttributeboolean

            If set to true, this attribute will not affect the number of rows in the cube.
        • qCalcCondobject
          Show qCalcCond properties
          • qvstring

            Expression evaluated to dual.
        • qCalcConditionobject
          Show qCalcCondition properties
          • qCondobject
            Show qCond properties
            • qvstring

              Expression evaluated to dual.
          • qMsgobject
            Show qMsg properties
            • qvstring

              Expression evaluated to string.
        • qTrendLinesarray of objects
          Experimental

          Specifies trendlines for this measure.

          Show qTrendLines properties
          • qTypestring

            Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"

          • qXColIxinteger

            The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure

            default = -1, format = int32, default = -1

          • qCalcR2boolean

            Set to true to calulatate the R2 score

            default = false

          • qContinuousXAxisstring

            Can be one of: "Never""Possible""Time"

          • qMultiDimModestring

            Can be one of: "Multi""Sum"

        • qMiniChartDefobject
          Show qMiniChartDef properties
          • qDefstring

            Expression or field name.

          • qLibraryIdstring

            LibraryId for dimension.

          • qSortByobject
            Show qSortBy properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequencyinteger

              Sorts the field values by frequency (number of occurrences in the field).

              format = int8

            • qSortByNumericinteger

              Sorts the field values by numeric value.

              format = int8

            • qSortByAsciiinteger

              Sorts the field by alphabetical order.

              format = int8

            • qSortByLoadOrderinteger

              Sorts the field values by the initial load order.

              format = int8

            • qSortByExpressioninteger

              Sorts the field by expression.

              format = int8

            • qExpressionobject
              Show qExpression properties
              • qvstring

                Expression evaluated to dual.
            • qSortByGreynessinteger

              format = int8

          • qOtherTotalSpecobject
            Show qOtherTotalSpec properties
            • qOtherModestring

              Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"

            • qOtherCountedobject
              Show qOtherCounted properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitobject
              Show qOtherLimit properties
              • qvstring

                Expression evaluated to dual.
            • qOtherLimitModestring

              Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"

            • qSuppressOtherboolean

              If set to true, the group Others is not displayed as a dimension value. The default value is false.

              default = false

            • qForceBadValueKeepingboolean

              This parameter is used when qOtherMode is set to:

              • OTHER_ABS_LIMITED
              • OTHER_REL_LIMITED
              • OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET

              and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true.

              default = true

            • qApplyEvenWhenPossiblyWrongResultboolean

              Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true.

              default = true

            • qGlobalOtherGroupingboolean

              This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false.

              default = false

            • qOtherCollapseInnerDimensionsboolean

              If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.

              default = false

            • qOtherSortModestring

              Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"

            • qTotalModestring

              Can be one of: "TOTAL_OFF""TOTAL_EXPR"

            • qReferencedExpressionobject
              Show qReferencedExpression properties
              • qvstring

                Expression evaluated to string.
          • qMaxNumberPointsinteger

            default = -1, format = int32, default = -1

          • qAttributeExpressionsarray of objects

            List of attribute expressions.

            Show qAttributeExpressions properties
            • qExpressionstring

              Definition of the attribute expression. Example: "Max(OrderID)"

            • qLibraryIdstring

              Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"

            • qAttributeboolean

              If set to true, this measure will not affect the number of rows in the cube.

            • qNumFormatobject

              Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

              Formatting mechanism

              The formatting mechanism depends on the type set in qType, as shown below:

              In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

              Type is DATE, TIME, TIMESTAMP or INTERVAL

              The following applies:

              • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
              • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
              • The properties qDec , qThou , qnDec , qUseThou are not used.

              Type is INTEGER

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

              Type is REAL

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
              • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
              • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is FIX

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
              • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

              Type is MONEY

              The following applies:

              • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
              • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

              Type is ASCII

              No formatting, qFmt is ignored.

              Show qNumFormat properties
              • qTypestring

                Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

              • qnDecinteger

                Number of decimals. Default is 10.

                default = 10, format = int32, default = 10

              • qUseThouinteger

                Defines whether or not a thousands separator must be used. Default is 0.

                default = 0, format = int32, default = 0

              • qFmtstring

                Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

              • qDecstring

                Defines the decimal separator. Example: .

              • qThoustring

                Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
            • qLabelstring

              Label of the attribute expression.

            • qLabelExpressionstring

              Optional expression used for dynamic label.
          • qNullSuppressionboolean

            If set to true, no null values are returned.
      • qInterColumnSortOrderarray of integers

        Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.

      • qSuppressZeroboolean

        Removes zero values.

        default = false

      • qSuppressMissingboolean

        Removes missing values.

        default = false

      • qInitialDataFetcharray of objects

        Initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeightinteger

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qReductionModestring

        Can be one of: "N""D1""S""C""ST"

      • qModestring

        Can be one of: "S""P""K""T""D"

      • qPseudoDimPosinteger

        default = -1, format = int32, default = -1

      • qNoOfLeftDimsinteger

        Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:

        • Four dimensions in the following order: Country, City, Product and Category.
        • One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder ) qInterColumnSortOrder is (0,-1,1,2,3).
        • Three left dimensions ( qNoOfLeftDims is set to 3).

        implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the pseudo dimension.
        • The index 2 corresponds to the left dimension City.
        • Product and Category are top dimensions.

        Another example:

        • Four dimensions in the following order: Country, City, Product and Category.
        • Three left dimensions ( qNoOfLeftDims is set to 3).
        • One pseudo dimension.
        • The property qInterColumnSortOrder is left empty.

        Implies that:

        • The index 0 corresponds to the left dimension Country.
        • The index 1 corresponds to the left dimension City.
        • The index 2 corresponds to the left dimension Product.
        • Category is a top dimension.
        • The pseudo dimension is a top dimension.

        default = -1, format = int32, default = -1

      • qAlwaysFullyExpandedboolean

        If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false.

        default = false

      • qMaxStackedCellsinteger

        Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K). The default value is 5000.

        default = 5000, format = int32, default = 5000

      • qPopulateMissingboolean

        If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false.

        default = false

      • qShowTotalsAboveboolean

        If set to true, the total (if any) is shown on the first row. The default value is false.

        default = false

      • qIndentModeboolean

        This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false.

        default = false

      • qCalcCondobject
        Show qCalcCond properties
        • qvstring

          Expression evaluated to dual.
      • qSortbyYValueinteger

        To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.

        default = 0, format = int8, default = 0

      • qTitleobject
        Show qTitle properties
        • qvstring

          Expression evaluated to string.
      • qCalcConditionobject
        Show qCalcCondition properties
        • qCondobject
          Show qCond properties
          • qvstring

            Expression evaluated to dual.
        • qMsgobject
          Show qMsg properties
          • qvstring

            Expression evaluated to string.
      • qColumnOrderarray of integers

        The order of the columns.

      • qExpansionStatearray of objects
        Experimental

        Expansion state per dimension for pivot mode ( qMode is P).

        Show qExpansionState properties
        • qExcludeListboolean
        • qPosobject
          Show qPos properties
          • qDimNamestring
          • qElemNoarray of integers
          • qElemValuesarray of strings
      • qDynamicScriptarray of strings
        Experimental

        Hypercube Modifier Dynamic script string

      • qContextSetExpressionstring

        Set Expression valid for the whole cube. Used to limit computations to the set specified.

      • qSuppressMeasureTotalsboolean

        If set to true, suppress any measure grand totals, ignoring any AggrFunc.
    • qLayoutExcludeobject

      Contains JSON to be excluded from validation.

    • qListObjectDefobject

      Defines the properties of a list object. For more information about the definition of a list object, see Generic object.

      Show qListObjectDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qLibraryIdstring

        Refers to a dimension stored in the library.

      • qDefobject
        Show qDef properties
        • qGroupingstring

          Can be one of: "N""H""C"

        • qFieldDefsarray of strings

          Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

        • qFieldLabelsarray of strings

          Array of field labels. This parameter is optional.

        • qSortCriteriasarray of objects

          Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

          Show qSortCriterias properties
          • qSortByStateinteger

            Sorts the field values according to their logical state (selected, optional, alternative or excluded).

            format = int8

          • qSortByFrequencyinteger

            Sorts the field values by frequency (number of occurrences in the field).

            format = int8

          • qSortByNumericinteger

            Sorts the field values by numeric value.

            format = int8

          • qSortByAsciiinteger

            Sorts the field by alphabetical order.

            format = int8

          • qSortByLoadOrderinteger

            Sorts the field values by the initial load order.

            format = int8

          • qSortByExpressioninteger

            Sorts the field by expression.

            format = int8

          • qExpressionobject
            Show qExpression properties
            • qvstring

              Expression evaluated to dual.
          • qSortByGreynessinteger

            format = int8

        • qNumberPresentationsarray of objects

          Defines the format of the value. This parameter is optional.

          Show qNumberPresentations properties
          • qTypestring

            Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

          • qnDecinteger

            Number of decimals. Default is 10.

            default = 10, format = int32, default = 10

          • qUseThouinteger

            Defines whether or not a thousands separator must be used. Default is 0.

            default = 0, format = int32, default = 0

          • qFmtstring

            Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

          • qDecstring

            Defines the decimal separator. Example: .

          • qThoustring

            Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
        • qReverseSortboolean

          If set to true, it inverts the sort criteria in the field.

        • qActiveFieldinteger

          Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( qGrouping is C).

          format = int32

        • qLabelExpressionstring

          Label expression. This parameter is optional.

        • qAliasstring

          Alias of the dimension.
      • qAutoSortByStateobject
        Show qAutoSortByState properties
        • qDisplayNumberOfRowsinteger

          This parameter applies to list objects. If the total number of values in the list object is greater than the value set in qDisplayNumberOfRows , the selected lines are promoted at the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

          format = int32

      • qFrequencyModestring

        Can be one of: "N""V""P""R"

      • qShowAlternativesboolean

        If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.

      • qInitialDataFetcharray of objects

        Fetches an initial data set.

        Show qInitialDataFetch properties
        • qLeftinteger

          Position from the left. Corresponds to the first column.

          format = int32

        • qTopinteger

          Position from the top. Corresponds to the first row.

          format = int32

        • qWidthinteger

          Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

        • qHeightinteger

          Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

          format = int32

      • qExpressionsarray of objects

        Lists the expressions in the list object. This parameter is optional.

        Show qExpressions properties
        • qExprstring

          Value of the expression.

        • qLibraryIdstring

          Refers to an expression stored in the library.
      • qDirectQuerySimplifiedViewboolean
        Experimental

        If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
    • qMeasureListDefobject

      Defines the list of measures.

      Show qMeasureListDef properties
      • qTypestring

        Type of the list.

      • qDataobject

        Contains dynamic JSON data specified by the client.
    • qMediaListDefobject

      Defines the list of media files.

      This struct is deprecated.

      Properties

      "qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.

    • qNxLibraryDimensionDefobject
      Show qNxLibraryDimensionDef properties
      • qGroupingstring

        Can be one of: "N""H""C"

      • qFieldDefsarray of strings

        Array of dimension names.

      • qFieldLabelsarray of strings

        Array of dimension labels.

      • qLabelExpressionstring
      • qAliasstring

        Alias of the dimension.

      • qScriptGeneratedbooleanDeprecated

        default = false

      • qOriginstring

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qNxLibraryMeasureDefobject
      Show qNxLibraryMeasureDef properties
      • qLabelstring

        Label of the measure.

      • qDefstring

        Definition of the measure.

      • qGroupingstring

        Can be one of: "N""H""C"

      • qExpressionsarray of strings

        Array of expressions.

      • qActiveExpressioninteger

        Index to the active expression in a measure.

        format = int32

      • qLabelExpressionstring

        Optional expression used for dynamic label.

      • qNumFormatobject

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show qNumFormat properties
        • qTypestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • qnDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • qUseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

        • qFmtstring

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • qDecstring

          Defines the decimal separator. Example: .

        • qThoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
      • qScriptGeneratedbooleanDeprecated

        default = false

      • qOriginstring

        Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"

    • qSelectionObjectDefobject

      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
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .
    • qStaticContentUrlDefobject
      In addition, this structure can contain dynamic properties.
      Show qStaticContentUrlDef properties
      • qUrlstring

        Relative path of the thumbnail.
    • qStringExpressionobject

      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
      • qExprstring
    • qTreeDataDefobject

      Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.

      Show qTreeDataDef properties
      • qStateNamestring

        Name of the alternate state. Default is current selections $ .

      • qDimensionsarray of objects

        Array of dimensions.

        Show qDimensions properties
        • qLibraryIdstring

          Refers to a dimension stored in the library.

        • qDefobject
          Show qDef properties
          • qGroupingstring

            Can be one of: "N""H""C"

          • qFieldDefsarray of strings

            Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.

          • qFieldLabelsarray of strings

            Array of field labels. This parameter is optional.

          • qSortCriteriasarray of objects

            Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.

            Show qSortCriterias properties
            • qSortByStateinteger

              Sorts the field values according to their logical state (selected, optional, alternative or excluded).

              format = int8

            • qSortByFrequency