---
source: https://qlik.dev/apis/json-rpc/qix/
last_updated: 2026-05-12T12:27:38+01:00
---
# Qlik Sense Engine (qix)
`Version: 12.2802.0`
The JSON-RPC API over WebSocket API that enables you to interact with the Qlik Associative Engine for Qlik Sense applications.
## Table of Contents
### Methods
- [Doc](#doc)
- [Field](#field)
- [GenericBookmark](#genericbookmark)
- [GenericDimension](#genericdimension)
- [GenericMeasure](#genericmeasure)
- [GenericObject](#genericobject)
- [GenericVariable](#genericvariable)
- [Global](#global)
- [Variable](#variable)
### Types
- [Errors](#errors)
- [Schemas](#schemas)
## Doc
### AbortModal
Aborts any selection mode in an app. For more information about selection mode, see _BeginSelections method_.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qAccept` | `boolean` | Yes | Set this parameter to true to accept the selections before exiting the selection mode. |
**Returns:** `object`
---
### AddAlternateState
**Access control:** `update`
Adds an alternate state in the app.
You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStateName` | `string` | Yes | Name of the alternate state. |
**Returns:** `object`
**See also:**
- Add an alternate state
---
### AddFieldFromExpression
Adds a field on the fly.
The expression of a field on the fly is persisted but not its values.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qName` | `string` | Yes | Name of the field. |
| `qExpr` | `string` | Yes | Expression value. It is not possible to use all aggregation functions. For example, you cannot add a field on the fly with an expression that uses the _Sum_ or _Count_ aggregation functions. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### AddSessionAlternateState
Adds an session alternate state in the app.
You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.
A session alternate state is not persisted and is not included in the StateNames array in the AppLayout.
You can use the optional second parameter to choose any other state to get the initial selection on the new state from
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStateName` | `string` | Yes | Name of the alternate state. |
| `qSourceStateName` | `string` | No | Name of existing state to copy the initial selections from |
**Returns:** `object`
---
### ApplyAndVerifyBookmark **[experimental]**
Applies a bookmark and verifies result dataset against originally selected values.
The operation is successful if **qApplySuccess** is set to true. **qWarnings** lists state and field with unmatching values
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the bookmark. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [BookmarkApplyAndVerifyResult](#bookmarkapplyandverifyresult) | |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qApplySuccess` | `boolean` | Apply successfully or not * |
| `qWarnings` | `array` of [BookmarkFieldVerifyWarning](#bookmarkfieldverifywarning) | Field values verfication result * |
| `qGroupStateResult` | [ApplyGroupStatesResult](#applygroupstatesresult) | Result of applying GroupState to multiple cyclic groups. |
Properties of `qWarnings`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkFieldVerifyWarning` | [BookmarkFieldVerifyWarning](#bookmarkfieldverifywarning) | |
Properties of `BookmarkFieldVerifyWarning`
_Properties truncated due to depth limit._
Properties of `qGroupStateResult`
| Name | Type | Description |
| --- | --- | --- |
| `qApplySuccess` | `boolean` | When true, the operation was successful. |
| `qWarnings` | `array` of [ApplyGroupStateWarning](#applygroupstatewarning) | Lists which states failed to be applied and why. |
Properties of `qWarnings`
**Array items:**
_Properties truncated due to depth limit._
---
### ApplyBookmark
Applies a bookmark.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the bookmark. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### ApplyGroupStates **[experimental]**
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qGroupStates` | `array` of [GroupState](#groupstate) | Yes | |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [ApplyGroupStatesResult](#applygroupstatesresult) | Result of applying GroupState to multiple cyclic groups. |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qApplySuccess` | `boolean` | When true, the operation was successful. |
| `qWarnings` | `array` of [ApplyGroupStateWarning](#applygroupstatewarning) | Lists which states failed to be applied and why. |
Properties of `qWarnings`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ApplyGroupStateWarning` | [ApplyGroupStateWarning](#applygroupstatewarning) | |
Properties of `ApplyGroupStateWarning`
_Properties truncated due to depth limit._
---
### ApplyTemporaryBookmark
Apply temporary bookmark identified by Id.
ApplyTemporaryBookmark method is only supported in SaaS Editions of Qlik Sense.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the temporary selection state |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### Back
Loads the last logical operation (if any).
**Returns:** `object`
---
### BackCount
Returns the number of entries on the back stack.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `integer` | |
---
### ChangeSessionAppOwner **[experimental]**
**Access control:** `change_owner`
Change the owner of a session app.
Can be used by a privileged user when creating a session app to be consumed by another user.
Only useful in environments where it is possible to reconnect to a session app, currently only in cloud deployments.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qNewOwnerId` | `string` | Yes | Identifier of the new app owner. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### ChangeSessionAppSpace **[experimental]**
Add a session app to a space.
Can be used by a privileged user when creating a session app to be consumed by other users.
Only useful in environments where it is possible to reconnect to a session app, currently only in cloud deployments.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qSpaceId` | `string` | Yes | Identifier of the new space. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### CheckExpression
Checks if a given expression is valid.
The expression is correct if the parameters _qErrorMsg_ , _qBadFieldNames_ and _qDangerousFieldNames_ are empty.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qExpr` | `string` | Yes | Expression to check. |
| `qLabels` | `array of string` | No | List of labels. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qErrorMsg` | `string` | |
| `qBadFieldNames` | `array` of [NxRange](#nxrange) | |
| `qDangerousFieldNames` | `array` of [NxRange](#nxrange) | |
Properties of `qBadFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxRange` | [NxRange](#nxrange) | |
Properties of `NxRange`
| Name | Type | Description |
| --- | --- | --- |
| `qFrom` | `integer` | Position in the expression of the first character of the field name. |
| `qCount` | `integer` | Number of characters in the field name. |
Properties of `qDangerousFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxRange` | [NxRange](#nxrange) | |
Properties of `NxRange`
| Name | Type | Description |
| --- | --- | --- |
| `qFrom` | `integer` | Position in the expression of the first character of the field name. |
| `qCount` | `integer` | Number of characters in the field name. |
---
### CheckNumberOrExpression
Checks if:
* A given expression is valid.
* A number is correct according to the locale.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qExpr` | `string` | Yes | Expression to check. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qErrorMsg` | `string` | |
| `qBadFieldNames` | `array` of [NxRange](#nxrange) | |
Properties of `qBadFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxRange` | [NxRange](#nxrange) | |
Properties of `NxRange`
| Name | Type | Description |
| --- | --- | --- |
| `qFrom` | `integer` | Position in the expression of the first character of the field name. |
| `qCount` | `integer` | Number of characters in the field name. |
---
### CheckScriptSyntax
**Access control:** `reload`
Checks the syntax of a script.
**Example**
"result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }
The first area is the primary error area, the second area is the secondary error area. The second area is optional and is shown only if qSecondaryFailure is set to true. The second area ends when the next statement in the script begins.
The list of syntax errors in the script.
If there are no errors, the engine returns:
If there are errors, the engine returns the following properties in the response:
| Name |
Description |
Type |
| qErrLen |
Length of the word where the error is located. |
Integer |
| qTabIx |
Number of the faulty section. |
Integer |
| qLineInTab |
Line number in the section where the error is located. |
Integer |
| qColInLine |
Position of the erroneous text from the beginning of the line. |
Integer |
| qTextPos |
Position of the erroneous text from the beginning of the script. |
Integer |
| qSecondaryFailure |
The default value is false. |
Boolean |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qErrors` | `array` of [ScriptSyntaxError](#scriptsyntaxerror) | |
Properties of `qErrors`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ScriptSyntaxError` | [ScriptSyntaxError](#scriptsyntaxerror) | |
Properties of `ScriptSyntaxError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrLen` | `integer` | Length of the word where the error is located. |
| `qTabIx` | `integer` | Number of the faulty section. |
| `qLineInTab` | `integer` | Line number in the section where the error is located. |
| `qColInLine` | `integer` | Position of the erroneous text from the beginning of the line. |
| `qTextPos` | `integer` | Position of the erroneous text from the beginning of the script. |
| `qSecondaryFailure` | `boolean` | The default value is false. |
---
### ClearAll
Clear selections in fields for current state. Locked fields are not cleared by default.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qLockedAlso` | `boolean` | No | When true, clears the selection for locked fields. |
| `qStateName` | `string` | No | Alternate state name. When set, applies to alternate state instead of current |
**Returns:** `object`
---
### ClearAllSoftPatches **[experimental]**
Clear the soft properties of all generic objects in the app
**Returns:** `object`
---
### ClearUndoBuffer
Clears entirely the undo and redo buffer.
**Returns:** `object`
---
### CloneBookmark
**Access control:** `create`
Clones a bookmark.
The identifier is set by the engine.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the object to clone. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qCloneId` | `string` | |
---
### CloneDimension
**Access control:** `create`
Clones a dimension.
The identifier is set by the engine.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the object to clone. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qCloneId` | `string` | |
---
### CloneMeasure
**Access control:** `create`
Clones a measure.
The identifier is set by the engine.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the object to clone. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qCloneId` | `string` | |
---
### CloneObject
**Access control:** `create`
Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.
When you clone an object that contains children, the children are cloned as well.
If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.
It is not possible to clone a session object.
The identifier is set by the engine.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the object to clone. The identifier must be a root object. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qCloneId` | `string` | |
---
### CommitDraft _(deprecated)_
**Access control:** `update`
Commits the draft of an object that was previously created by invoking the _CreateDraft method_.
Committing a draft replaces the corresponding published object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the draft to commit. |
**Returns:** `object`
---
### CommitScript **[experimental]**
**Access control:** `update`
Commits the current script version so that any future changes will be part of a new version.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qCommitMessage` | `string` | No | Name of the version. Only applicable to QCS.
|
**Returns:** `object`
---
### CreateBookmark
**Access control:** `create`
Creates a bookmark.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericBookmarkProperties](#genericbookmarkproperties) | Yes | Properties for the object. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### CreateBookmarkEx **[experimental]**
**Access control:** `create`
Creates a bookmark with softpatches.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericBookmarkProperties](#genericbookmarkproperties) | Yes | Properties for the object. |
| `qObjectIdsToPatch` | `array of string` | No | Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### CreateConnection
**Access control:** `create`
Creates a connection.
A connection indicates from which data source the data should be taken.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnection` | [Connection](#connection) | Yes | Information about the connection. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qConnectionId` | `string` | |
---
### CreateDimension
**Access control:** `create`
Creates a master dimension.
A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericDimensionProperties](#genericdimensionproperties) | Yes | Information about the properties. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### CreateDraft _(deprecated)_
**Access control:** `create`
Creates a draft of an object.
This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.
Replace the published object by the content of the draft by invoking the _CommitDraft method_.
The identifier is set by the engine.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the object to create a draft from. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDraftId` | `string` | |
---
### CreateMeasure
**Access control:** `create`
Creates a master measure.
A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericMeasureProperties](#genericmeasureproperties) | Yes | Information about the properties. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### CreateObject
**Access control:** `create`
Creates a generic object at app level. For more information on generic objects, see _Generic object_.
It is possible to create a generic object that is linked to another object.
A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in _qExtendsId_ ).
The linked object has the same properties as the linking object.
The linking object cannot be a transient object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericObjectProperties](#genericobjectproperties) | Yes | Information about the object. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### CreateSessionObject
Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.
It is possible to create a transient object that is linked to another object.
A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in _qExtendsId_ ).
The linked object has the same properties as the linking object.
The linking object cannot be a transient object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericObjectProperties](#genericobjectproperties) | Yes | Information about the object. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### CreateSessionVariable
Creates a transient variable.
To set some properties to the variable, use the _SetProperties method_.
**Definition**
A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.
When a variable is used in an expression, it is substituted by its value or the variable's definition.
**Example**
The variable _x_ contains the text string _Sum(Sales)_ .
In a chart, you define the expression _$(x)/12_ . The effect is exactly the same as having the chart expression _Sum(Sales)/12_ .
However, if you change the value of the variable _x_ to _Sum(Budget)_ , the data in the chart are immediately recalculated with the expression interpreted as _Sum(Budget)/12_ .
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericVariableProperties](#genericvariableproperties) | Yes | Name of the variable. Variable names are case sensitive. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### CreateTemporaryBookmark
Create temporary bookmark
CreateTemporaryBookmark method is only supported in SaaS Editions of Qlik Sense.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [NxTempBookmarkOptions](#nxtempbookmarkoptions) | Yes | Options for the temporary bookmark |
| `qObjectIdsToPatch` | `array of string` | No | Add softpatches for these objects to the bookmark if available. If IncludePatches is true, softpatches are included for all objects. Any session objects included are also added to the bookmark. IncludePatches has no effect on the patching of session objects. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qReturn` | `boolean` | |
---
### CreateVariable _(deprecated)_
> **Deprecated:** Use _Doc::CreateVariableEx_ method instead
**Access control:** `update`
Creates a variable.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qName` | `string` | Yes | Name of the variable. Variable names are case sensitive. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### CreateVariableEx
**Access control:** `create`
Creates a variable.
To create a variable via a script, you need to use the _SetScript method_. For more information, see _Create a variable_.
To set some properties to the variable, use the _SetProperties method_.
In a published app, only transient variables can be created. See _CreateSessionVariable method_.
**Definition**
A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.
When a variable is used in an expression, it is substituted by its value or the variable's definition.
**Example**
The variable _x_ contains the text string _Sum(Sales)_ .
In a chart, you define the expression _$(x)/12_ . The effect is exactly the same as having the chart expression _Sum(Sales)/12_ .
However, if you change the value of the variable _x_ to _Sum(Budget)_ , the data in the chart are immediately recalculated with the expression interpreted as _Sum(Budget)/12_ .
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericVariableProperties](#genericvariableproperties) | Yes | Name of the variable. Variable names are case sensitive and must be unique. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### DeleteConnection
**Access control:** `delete`
Deletes a connection.
In Qlik Sense Enterprise, there is an additional file connection named _AttachedFiles_ . The AttachedFiles connection can only be removed by the administrator of the system.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection to remove. |
**Returns:** `object`
---
### DestroyBookmark
**Access control:** `delete`
Removes a bookmark.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the bookmark. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroyDimension
**Access control:** `delete`
Removes a dimension.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the dimension to remove. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroyDraft _(deprecated)_
**Access control:** `delete`
Removes the draft of an object.
The children of the draft object (if any) are removed as well.
This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the draft object to remove. |
| `qSourceId` | `string` | Yes | Identifier of the source object (the object from which a draft was created). |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroyMeasure
**Access control:** `delete`
Removes a generic measure.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the measure to remove. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroyObject
**Access control:** `delete`
Removes an app object.
The children of the object (if any) are removed as well.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the object to remove. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroySessionObject
Removes a transient object.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the transient object to remove. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroySessionVariable
Removes a transient variable.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the variable. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroySessionVariableById
Removes a transient variable.
**qSuccess** is set to true if the operation is successful.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the variable. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroySessionVariableByName
Removes a transient variable.
**qSuccess** is set to true if the operation is successful.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qName` | `string` | Yes | Name of the variable. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroyVariableById
**Access control:** `delete`
Removes a variable.
Script-defined variables cannot be removed using the _DestroyVariableById method_ or the _DestroyVariableByName method_. For more information, see _Remove a variable_.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the variable. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DestroyVariableByName
**Access control:** `delete`
Removes a variable.
Script-defined variables cannot be removed using the _DestroyVariableById method_ or the _DestroyVariableByName method_. For more information, see _Remove a variable_.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qName` | `string` | Yes | Name of the variable. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### DoReload
**Access control:** `reload`
Reloads the script that is set in an app.
**Logs**
When this method is called, audit activity logs are produced to track the user activity.
In the case of errors, both audit activity logs and system services logs are produced.
The log files are named as follows:
| Audit activity log |
System service log |
<MachineName>_AuditActivity_Engine.txt in Qlik Sense Enterprise
<MachineName>_AuditActivity_Engine.log in Qlik Sense Desktop |
<MachineName>_Service_Engine.txt in Qlik Sense Enterprise
<MachineName>_Service_Engine.log in Qlik Sense Desktop |
**Where to find the log files**
The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.
| Qlik Sense Enterprise |
Qlik Sense Desktop |
| %ProgramData%/Qlik/Sense/Log/Engine |
%UserProfile%/Documents/Qlik/Sense/Log |
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qMode` | `integer` | No | Error handling mode One of: * 0: for default mode. * 1: for ABEND; the reload of the script ends if an error occurs. * 2: for ignore; the reload of the script continues even if an error is detected in the script. |
| `qPartial` | `boolean` | No | Set to true for partial reload. The default value is false. |
| `qDebug` | `boolean` | No | Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### DoReloadEx
**Access control:** `reload`
Reloads the script that is set in an app and returns the path to the script log file.
A log file is created per reload.
**Logs**
When this method is called, audit activity logs are produced to track the user activity.
In the case of errors, both audit activity logs and system services logs are produced.
The log files are named as follows:
| Audit activity log |
System service log |
< MachineName>AuditActivityEngine.txt in Qlik Sense Enterprise
< MachineName>AuditActivityEngine.log in Qlik Sense Desktop |
< MachineName>ServiceEngine.txt in Qlik Sense Enterprise
< MachineName>ServiceEngine.log in Qlik Sense Desktop |
**Where to find the log files**
The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.
| Qlik Sense Enterprise |
Qlik Sense Desktop |
| %ProgramData%/Qlik/Sense/Log/Engine |
%UserProfile%/Documents/Qlik/Sense/Log |
**DoReloadExParams**
| Name |
Description |
Type |
| qMode |
Error handling mode
One of:
- 0: for default mode.
- 1: for ABEND; the reload of the script ends if an error occurs.
- 2: for ignore; the reload of the script continues even if an error is detected in the script.
|
Integer |
| qPartial |
Set to true for partial reload.
The default value is false. |
Boolean |
| qDebug |
Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode.
The default value is false. |
Boolean |
**DoReloadExResult**
| Name |
Description |
Type |
| qSuccess |
The operation is successful if qSuccess is set to True. |
Boolean |
| qScriptLogFile |
Path to the script log file. |
String |
If the data load has successfully finished, no matter how the indexing behaves, _true_ is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qParams` | [DoReloadExParams](#doreloadexparams) | No | |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [DoReloadExResult](#doreloadexresult) | The result and path to script log for a reload. |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | The reload is successful if True. |
| `qScriptLogFile` | `string` | Path to the script log file. |
| `qEndedWithMemoryConstraint` | `boolean` | true if memory limits were exhausted during reload. |
| `qNbrOfLoadedRows` | `integer` | Number of read rows during a reload |
| `qNbrOfStoredRows` | `integer` | Number of stored rows from a reload |
| `qFailureData` | [FailureData](#failuredata) | |
Properties of `qFailureData`
| Name | Type | Description |
| --- | --- | --- |
| `qErrors` | `array` of [ReloadError](#reloaderror) | Array of errors accumulated during reload. |
Properties of `qErrors`
**Array items:**
_Properties truncated due to depth limit._
---
### DoSave
**Access control:** `update`
Saves an app. All objects and data in the data model are saved.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFileName` | `string` | No | Name of the file to save. |
**Returns:** `object`
---
### Evaluate
Evaluates an expression and returns the result as a string.
**Example**
The client sends:
```
{
"handle": 1,
"method": "Evaluate",
"params": {
"qExpression": "Sum(Holes)"
},
"id": 6,
"jsonrpc": "2.0"
}
```
The engine returns:
```
{
"jsonrpc": "2.0",
"id": 6,
"result": {
"qReturn": "361716"
}
}
```
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qExpression` | `string` | Yes | Expression to evaluate. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
---
### EvaluateEx
Evaluates an expression and returns the result as a dual.
**Example**
The client sends:
```
{
"handle": 1,
"method": "EvaluateEx",
"params": {
"qExpression": "Sum(Holes)"
},
"id": 7,
"jsonrpc": "2.0"
}
```
The engine returns:
```
{
"jsonrpc": "2.0",
"id": 7,
"result": {
"qReturn": "361716"
}
}
```
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qExpression` | `string` | Yes | Expression to evaluate. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qValue` | [FieldValue](#fieldvalue) | |
Properties of `qValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
---
### ExpandExpression
Expands the expression.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qExpression` | `string` | Yes | The expression string to expand. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qExpandedExpression` | `string` | |
---
### ExportReducedData
Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.
This API is only available on Sense Enterprise on Windows
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [NxDownloadOptions](#nxdownloadoptions) | No | BookmarkId used to reduced the app on and an expire time. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDownloadInfo` | [NxDownloadInfo](#nxdownloadinfo) | |
Properties of `qDownloadInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | URL to download the reduced app on. |
| `qFileSize` | `integer` | The filesize of the reduced app. |
---
### FindMatchingFields
Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.
Tags set by Qlik Sense are prefixed by the _$_ sign.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFieldName` | `string` | Yes | Name of the field. This method looks for fields that belong to the same archipelago as this specified field. |
| `qTags` | `array of string` | Yes | List of tags. This method looks for fields that match at least one of the tags in this list. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFieldNames` | `array` of [NxMatchingFieldInfo](#nxmatchingfieldinfo) | |
Properties of `qFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMatchingFieldInfo` | [NxMatchingFieldInfo](#nxmatchingfieldinfo) | |
Properties of `NxMatchingFieldInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qTags` | `array of string` | List of tags. |
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
---
### Forward
Loads the next logical operation (if any).
**Returns:** `object`
---
### ForwardCount
Returns the number of entries on the Forward stack.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `integer` | |
---
### GetAllInfos
Returns the identifier and the type of any generic object in the app.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfos` | `array` of [NxInfo](#nxinfo) | |
Properties of `qInfos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxInfo` | [NxInfo](#nxinfo) | |
Properties of `NxInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### GetAppLayout
Evaluates an app.
Returns dynamic properties (if any) in addition to the engine (fixed) properties.
A data set is returned.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qLayout` | [NxAppLayout](#nxapplayout) | ### Qlik Sense Desktop In Qlik Sense Desktop, this structure can contain dynamic properties. ### Qlik Sense Enterprise In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted. The persisted dynamic properties are the following: * modifiedDate * published * publishTime * privileges * description * dynamicColor |
Properties of `qLayout`
| Name | Type | Description |
| --- | --- | --- |
| `qTitle` | `string` | Title of the app. |
| `qFileName` | `string` | In Qlik Sense Enterprise, this property corresponds to the app identifier (GUID). In Qlik Sense Desktop, this property corresponds to the full path of the app. |
| `qLastReloadTime` | `string` | Date and time of the last reload of the app in ISO format. |
| `qModified` | `boolean` | Is set to true if the app has been updated since the last save. |
| `qHasScript` | `boolean` | Is set to true if a script is defined in the app. |
| `qStateNames` | `array of string` | Array of alternate states. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qLocaleInfo` | [LocaleInfo](#localeinfo) | |
| `qHasData` | `boolean` | Is set to true if the app contains data following a script reload. |
| `qReadOnly` | `boolean` | If set to true, it means that the app is read-only. |
| `qIsOpenedWithoutData` | `boolean` | If set to true, it means that the app was opened without loading its data. |
| `qIsSessionApp` | `boolean` | If set to true, the app is a Session App, i.e. not persistent. |
| `qProhibitBinaryLoad` | `boolean` | If set to true, the persisted app cannot be used in a Binary load statement in Qlik load script. |
| `qThumbnail` | [StaticContentUrl](#staticcontenturl) | In addition, this structure can return dynamic properties.
|
| `qIsBDILiveMode` | `boolean` | If set to true, the app is in BDI Direct Query Mode. |
| `qIsDirectQueryMode` | `boolean` | If set to true, the app is in Direct Query Mode. |
| `qUnsupportedFeatures` | `array` of [NxFeature](#nxfeature) | Array of features not supported by the app. |
| `qUsage` | oneOf(ANALYTICS \| DATA_PREPARATION \| DATAFLOW_PREP \| SINGLE_TABLE_PREP \| DIRECT_QUERY_MODE) | |
Properties of `qStateNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qLocaleInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qDecimalSep` | `string` | Decimal separator. |
| `qThousandSep` | `string` | Thousand separator. |
| `qListSep` | `string` | List separator. |
| `qMoneyDecimalSep` | `string` | Money decimal separator. |
| `qMoneyThousandSep` | `string` | Money thousand separator. |
| `qCurrentYear` | `integer` | Current year. |
| `qMoneyFmt` | `string` | Money format. Example: _#.##0,00 kr;-#.##0,00 kr_ |
| `qTimeFmt` | `string` | Time format. Example: _hh:mm:ss_ |
| `qDateFmt` | `string` | Date format. Example: _YYYY-MM-DD_ |
| `qTimestampFmt` | `string` | Time stamp format. Example: _YYYY-MM-DD hh:mm:ss[.fff]_ |
| `qCalendarStrings` | [CalendarStrings](#calendarstrings) | |
| `qFirstWeekDay` | `integer` | First day of the week, starting from 0. According to ISO 8601, _Monday_ is the first day of the week. * 0 = Monday * 1 = Tuesday * ... * 6 = Sunday If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qBrokenWeeks` | `boolean` | Is set to true if broken weeks are allowed in a year. According to ISO 8601, no broken weeks should be allowed. This property is not shown if set to false. If _qBrokenWeeks_ is set to true, _qReferenceDay_ is irrelevant. If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qReferenceDay` | `integer` | Day in the year that is always in week 1. According to ISO 8601, January 4th should always be part of the first week of the year ( _qReferenceDay_ =4). Recommended values are in the range 1 and 7. If this property has not been set in a script, the returned value comes from the Windows operating system. This property is not relevant if there are broken weeks in the year. |
| `qFirstMonthOfYear` | `integer` | First month of the year, starting from 1. According to ISO 8601, _January_ is the first month of the year. * 1 = January * 2 = February * 12 = January If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qCollation` | `string` | Locale name (following language tagging convention RFC 4646): _< language>-<REGION>_ Where: * _language_ is a lowercase ISO 639 language code * _REGION_ specifies an uppercase ISO 3166 country code. If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qNumericalAbbreviation` | `string` | Number format. Example: 3:k;6:M;9:G;12:T;15:P;18:E;21:Z;24:Y;-3:m;-6:μ;-9:n;-12:p;-15:f;-18:a;-21:z;-24:y |
Properties of `qCalendarStrings`
_Properties truncated due to depth limit._
Properties of `qThumbnail`
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
Properties of `qUnsupportedFeatures`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxFeature` | oneOf(binningData \| bookmarks \| calculatedFields \| continuousData \| invertedSelections \| rangeSelections \| reducingData \| search \| selectionCount \| selectionInsights \| tableMiniChart \| trendlines \| calculatedDimensions \| includeZeroValues \| includeNullValues \| filterPanePaging \| filterPaneCustomSorting \| showFrequency \| limitation \| totals) | |
Properties of `NxFeature`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
**Option 11:**
_Properties truncated due to depth limit._
**Option 12:**
_Properties truncated due to depth limit._
**Option 13:**
_Properties truncated due to depth limit._
**Option 14:**
_Properties truncated due to depth limit._
**Option 15:**
_Properties truncated due to depth limit._
**Option 16:**
_Properties truncated due to depth limit._
**Option 17:**
_Properties truncated due to depth limit._
**Option 18:**
_Properties truncated due to depth limit._
**Option 19:**
_Properties truncated due to depth limit._
**Option 20:**
_Properties truncated due to depth limit._
Properties of `qUsage`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ANALYTICS` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `DATA_PREPARATION` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DATAFLOW_PREP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `SINGLE_TABLE_PREP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `DIRECT_QUERY_MODE` | `object` | |
---
### GetAppProperties
Gets the properties of an app.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProp` | [NxAppProperties](#nxappproperties) | ### Qlik Sense Desktop In Qlik Sense Desktop, this structure can contain dynamic properties. ### Qlik Sense Enterprise In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted. The persisted dynamic properties are the following: * modifiedDate * published * publishTime * privileges * description * dynamicColor |
Properties of `qProp`
| Name | Type | Description |
| --- | --- | --- |
| `qTitle` | `string` | App title. |
| `qLastReloadTime` | `string` | Last reload time of the app. |
| `qMigrationHash` | `string` | Internal property reserved for app migration. Patch version of the app. Do not update. |
| `qSavedInProductVersion` | `string` | Internal property reserved for app migration. The app is saved in this version of the product. Do not update. |
| `qThumbnail` | [StaticContentUrlDef](#staticcontenturldef) | In addition, this structure can contain dynamic properties.
|
| `qHasSectionAccess` | `boolean` | If true the app has section access configured. |
| `qUsage` | oneOf(ANALYTICS \| DATA_PREPARATION \| DATAFLOW_PREP \| SINGLE_TABLE_PREP \| DIRECT_QUERY_MODE) | |
Properties of `qThumbnail`
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
Properties of `qUsage`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ANALYTICS` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `DATA_PREPARATION` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DATAFLOW_PREP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `SINGLE_TABLE_PREP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `DIRECT_QUERY_MODE` | `object` | |
---
### GetAssociationScores
Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.
When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by _[Synthetic Key]:_ .
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qTable1` | `string` | Yes | Name of the first table. |
| `qTable2` | `string` | Yes | Name of the second table. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qScore` | `array` of [AssociationScore](#associationscore) | |
Properties of `qScore`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `AssociationScore` | [AssociationScore](#associationscore) | |
Properties of `AssociationScore`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldPairName` | `string` | Pair of fields. _< FieldName1>_ / _< FieldName2>_ Where: < _FieldName1_ > is a field in the table 1 (defined in _qTable1_ ) < _FieldName2_ > is a field in the table 2 (defined in _qTable2_ ) If the field is a synthetic key, the name of the field is preceded by _[Synthetic key]:_ . |
| `qScoreSummary` | `integer` | Flag used to interpret calculated scores. One of the following values or sum of values that apply: * 0: The cardinal ratio cannot be zero but the symbol score and the row score can be zero. * -1: The fields do not have the same type. * -2: The number of rows of the field _FieldName1_ is zero. * -4: The number of distinct values of the field _FieldName1_ is zero. * -8: The number of rows of the field _FieldName2_ is zero. * -16: The number of distinct values of the field _FieldName2_ is zero. Example: The number of rows of the field _FieldName1_ is zero, and the number of distinct values of the field _FieldName2_ is zero, then _qScoreSummary_ is -18. |
| `qField1Scores` | [FieldScores](#fieldscores) | |
| `qField2Scores` | [FieldScores](#fieldscores) | |
Properties of `qField1Scores`
_Properties truncated due to depth limit._
Properties of `qField2Scores`
_Properties truncated due to depth limit._
---
### GetBookmark
Returns the handle of a bookmark.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the bookmark. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetBookmarks
Returns all bookmarks compatible with options.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [NxGetBookmarkOptions](#nxgetbookmarkoptions) | Yes | Bookmark type filter and requested properties. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qList` | `array` of [NxContainerEntry](#nxcontainerentry) | |
Properties of `qList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxContainerEntry` | [NxContainerEntry](#nxcontainerentry) | |
Properties of `NxContainerEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qMeta`
_Properties truncated due to depth limit._
---
### GetConnection
**Access control:** `reload`
Retrieves a connection and returns:
* The creation time of the connection.
* The identifier of the connection.
* The type of the connection.
* The name of the connection.
* The connection string.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qConnection` | [Connection](#connection) | |
Properties of `qConnection`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the connection. Is generated by the engine and is unique. |
| `qName` | `string` | Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection. |
| `qConnectionString` | `string` | One of: * ODBC CONNECT TO [<provider name>] * OLEDB CONNECT TO [<provider name>] * CUSTOM CONNECT TO [<provider name>] * "<local absolute or relative path, UNC path>" * "<URL>" Connection string. This parameter is mandatory and must be set when creating or modifying a connection. |
| `qType` | `string` | One of: * ODBC * OLEDB * <Name of the custom connection file> * folder * internet Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive. |
| `qUserName` | `string` | Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to _GetConnection Method_ does not return the user name. |
| `qPassword` | `string` | Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to _GetConnection Method_ does not return the password. |
| `qModifiedDate` | `string` | Is generated by the engine. Creation date of the connection or last modification date of the connection. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qLogOn` | oneOf(LOG_ON_SERVICE_USER \| LOG_ON_CURRENT_USER) | |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qLogOn`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG_ON_SERVICE_USER` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG_ON_CURRENT_USER` | `object` | |
---
### GetConnections
**Access control:** `reload`
Lists the connections in an app.
In Qlik Sense Enterprise, there is an additional file connection named _AttachedFiles_ . This connection is stored in the Qlik Sense repository.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qConnections` | `array` of [Connection](#connection) | |
Properties of `qConnections`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `Connection` | [Connection](#connection) | |
Properties of `Connection`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the connection. Is generated by the engine and is unique. |
| `qName` | `string` | Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection. |
| `qConnectionString` | `string` | One of: * ODBC CONNECT TO [<provider name>] * OLEDB CONNECT TO [<provider name>] * CUSTOM CONNECT TO [<provider name>] * "<local absolute or relative path, UNC path>" * "<URL>" Connection string. This parameter is mandatory and must be set when creating or modifying a connection. |
| `qType` | `string` | One of: * ODBC * OLEDB * <Name of the custom connection file> * folder * internet Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive. |
| `qUserName` | `string` | Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to _GetConnection Method_ does not return the user name. |
| `qPassword` | `string` | Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to _GetConnection Method_ does not return the password. |
| `qModifiedDate` | `string` | Is generated by the engine. Creation date of the connection or last modification date of the connection. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qLogOn` | oneOf(LOG_ON_SERVICE_USER \| LOG_ON_CURRENT_USER) | |
Properties of `qMeta`
_Properties truncated due to depth limit._
Properties of `qLogOn`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
---
### GetContentLibraries
Lists the content libraries.
To differentiate a global content library from an app specific content library, you can check the property _qAppSpecific_ . If this property is set to true, it means that the content library is app specific.
There is always one specific content library per app.
**Qlik Sense**
Returns the global content libraries and the app specific content library.
When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.
By default, there is one global content library named _Default_ .
**Qlik Sense Desktop**
Returns the global content library and the app specific content library from the disk.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qList` | [ContentLibraryList](#contentlibrarylist) | |
Properties of `qList`
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [ContentLibraryListItem](#contentlibrarylistitem) | Information about the content library. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ContentLibraryListItem` | [ContentLibraryListItem](#contentlibrarylistitem) | |
Properties of `ContentLibraryListItem`
_Properties truncated due to depth limit._
---
### GetDatabaseInfo
**Access control:** `reload`
Gives information about an ODBC, OLEDB or CUSTOM connection. See _Outputs_ for more details.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Name of the connection. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [DatabaseInfo](#databaseinfo) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qDBMSName` | `string` | Name of the product accessed by the provider. |
| `qDBUsage` | `boolean` | If set to true, it means that the data source contains some databases. |
| `qOwnerUsage` | `boolean` | If set to true, it means that the data source contains some owners. |
| `qDBSeparator` | `string` | Character string used after the database name. Example with separator " **.** ": FROM LinkedTablesData.dbo.Months Where: * **LinkedTablesData** is the database name * **dbo** is the owner name * **Months** is the table name |
| `qOwnerSeparator` | `string` | Character string used after the owner name. Example with separator " **.** ": FROM LinkedTablesData.dbo.Months Where: * **LinkedTablesData** is the database name * **dbo** is the owner name * **Months** is the table name |
| `qDBFirst` | `boolean` | If set to true, it means that the database is displayed first, before the owners and tables. |
| `qQuotePreffix` | `string` | Prefix used with field, database or owner names that contain special characters or keywords. |
| `qQuoteSuffix` | `string` | Suffix used with field, database or owner names that contain special characters or keywords. |
| `qSpecialChars` | `string` | List of the special characters. |
| `qDefaultDatabase` | `string` | Name of the default database. |
| `qKeywords` | `array of string` | List of the script keywords. |
Properties of `qKeywords`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### GetDatabaseOwners
**Access control:** `reload`
Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qDatabase` | `string` | No | Name of the database. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qOwners` | `array` of [DatabaseOwner](#databaseowner) | |
Properties of `qOwners`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DatabaseOwner` | [DatabaseOwner](#databaseowner) | |
Properties of `DatabaseOwner`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the owner. |
---
### GetDatabaseTableFields
**Access control:** `reload`
Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qDatabase` | `string` | No | Name of the database. If _qDatabase_ is not set then _qOwner_ must be set. |
| `qOwner` | `string` | No | Owner of the database. If _qOwner_ is not set then _qDatabase_ must be set. |
| `qTable` | `string` | Yes | Name of the table. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFields` | `array` of [DataField](#datafield) | |
Properties of `qFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DataField` | [DataField](#datafield) | |
Properties of `DataField`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qIsKey` | `boolean` | Is set to true if the field is a primary key. |
| `qOriginalFieldName` | `string` | Is shown for fixed records. _qOriginalFieldName_ and _qName_ are identical if no field names are used in the file. _qOriginalFieldName_ differs from _qName_ if embedded file names are used in the file. |
---
### GetDatabaseTablePreview
**Access control:** `reload`
Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qDatabase` | `string` | No | Name of the database. If _qDatabase_ is not set then _qOwner_ must be set. |
| `qOwner` | `string` | No | Owner of the database. If _qOwner_ is not set then _qDatabase_ must be set. |
| `qTable` | `string` | Yes | Name of the table. |
| `qConditions` | [FilterInfo](#filterinfo) | No | |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qPreview` | `array` of [DataRecord](#datarecord) | |
| `qRowCount` | `integer` | |
Properties of `qPreview`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DataRecord` | [DataRecord](#datarecord) | |
Properties of `DataRecord`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array of string` | List of values inside the table. The first values (in _result/qPreview/0/qValues_ ) correspond to the field names in the table. The following values (from _result/qPreview/1/qValues_ ) are the values of the fields in the table. |
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
---
### GetDatabaseTables
**Access control:** `reload`
Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qDatabase` | `string` | No | Name of the database. If _qDatabase_ is not set then _qOwner_ must be set. |
| `qOwner` | `string` | No | Owner of the database. If _qOwner_ is not set then _qDatabase_ must be set. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qTables` | `array` of [DataTable](#datatable) | |
Properties of `qTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DataTable` | [DataTable](#datatable) | |
Properties of `DataTable`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the table. |
| `qType` | `string` | Type of the table. For example: Table or View. |
---
### GetDatabases
**Access control:** `reload`
Lists the databases inside a ODBC, OLEDB or CUSTOM data source.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDatabases` | `array` of [Database](#database) | |
Properties of `qDatabases`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `Database` | [Database](#database) | |
Properties of `Database`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the database. |
| `qIsDefault` | `boolean` | Is set to true if the database is set by default. |
---
### GetDimension
Returns the handle of a dimension.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the dimension. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetEmptyScript
**Access control:** `reload`
Creates a script that contains one section. This section contains **SET** statements that give localized information from the regional settings of the computer.
The computer regional settings are retrieved when the engine starts.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qLocalizedMainSection` | `string` | No | Name of the script section. The default value is _Main_ . |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
---
### GetExpressionBNF **[experimental]**
Gets the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qBnfDefs` | `array` of [BNFDef](#bnfdef) | |
| `qBnfHash` | `string` | |
Properties of `qBnfDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BNFDef` | [BNFDef](#bnfdef) | |
Properties of `BNFDef`
| Name | Type | Description |
| --- | --- | --- |
| `qBnf` | `array of integer` | Array of token references that all together build up the definition of the current token. Generally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF rules do have an empty array (_qIsBnfRule_ is set to true, but _qBnf_ is empty). |
| `qNbr` | `integer` | Number of the current token definition. |
| `qPNbr` | `integer` | Number of the parent rule definition. |
| `qHelpId` | `integer` | Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name. Is not used in Qlik Sense. |
| `qName` | `string` | Token name. One of: * A rule name * An identifier * A literal value |
| `qStr` | `string` | Literal string of the token. Examples: 'Round' and '('. |
| `qIsBnfRule` | `boolean` | If set to true, a list of related rule tokens is assigned to _qBnf_ . This parameter is optional. The default value is false. |
| `qScriptStatement` | `boolean` | If set to true, the definition specifies a script statement. This parameter is optional. The default value is false. |
| `qControlStatement` | `boolean` | If set to true, the definition specifies a control statement. This parameter is optional. The default value is false. |
| `qBnfLiteral` | `boolean` | If set to true, the definition specifies a literal token. This parameter is optional. The default value is false. |
| `qQvFunc` | `boolean` | If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function. This parameter is optional. The default value is false. |
| `qAggrFunc` | `boolean` | If set to true, the definition is related to an aggregation function. This parameter is optional. The default value is false. |
| `qFG` | oneOf(ALL \| U \| NONE \| AGGR \| NUM \| RNG \| EXP \| TRIG \| FIN \| MATH \| COUNT \| STR \| MAPP \| RCRD \| CND \| LOG \| NULL \| SYS \| FILE \| TBL \| DATE \| NUMI \| FRMT \| CLR \| RNK \| GEO \| EXT \| PROB \| ARRAY \| LEG \| DB \| WINDOW) | |
| `qFieldFlag` | `boolean` | If set to true, the definition is related to a field. This parameter is optional. The default value is false. |
| `qMT` | oneOf(N \| D \| R \| V) | |
| `qDepr` | `boolean` | Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use). If set to true, the script statement or the function is not recommended for use in Qlik Sense. This parameter is optional. The default value is false. |
| `qFGList` | `array` of [FunctionGroup](#functiongroup) | List of groups the function belongs to. |
Properties of `qBnf`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qFG`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
**Option 11:**
_Properties truncated due to depth limit._
**Option 12:**
_Properties truncated due to depth limit._
**Option 13:**
_Properties truncated due to depth limit._
**Option 14:**
_Properties truncated due to depth limit._
**Option 15:**
_Properties truncated due to depth limit._
**Option 16:**
_Properties truncated due to depth limit._
**Option 17:**
_Properties truncated due to depth limit._
**Option 18:**
_Properties truncated due to depth limit._
**Option 19:**
_Properties truncated due to depth limit._
**Option 20:**
_Properties truncated due to depth limit._
**Option 21:**
_Properties truncated due to depth limit._
**Option 22:**
_Properties truncated due to depth limit._
**Option 23:**
_Properties truncated due to depth limit._
**Option 24:**
_Properties truncated due to depth limit._
**Option 25:**
_Properties truncated due to depth limit._
**Option 26:**
_Properties truncated due to depth limit._
**Option 27:**
_Properties truncated due to depth limit._
**Option 28:**
_Properties truncated due to depth limit._
**Option 29:**
_Properties truncated due to depth limit._
**Option 30:**
_Properties truncated due to depth limit._
**Option 31:**
_Properties truncated due to depth limit._
**Option 32:**
_Properties truncated due to depth limit._
Properties of `qMT`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
Properties of `qFGList`
**Array items:**
_Properties truncated due to depth limit._
**See also:**
- [GetExpressionBNF method](#getexpressionbnf)
---
### GetExpressionBNFHash **[experimental]**
Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qBnfHash` | `string` | |
**See also:**
- [GetExpressionBNFHash method](#getexpressionbnfhash)
---
### GetFavoriteVariables
**Access control:** `reload`
Retrieves the variables that are tagged as favorite.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qNames` | `array of string` | |
Properties of `qNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### GetField
Returns a handle to a field.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFieldName` | `string` | Yes | Name of the field. |
| `qStateName` | `string` | No | Name of the alternate state. Default state is current selections. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetFieldAndColumnSamples
Get sample values from either a column in a table or from a field.
Supports wildcard matches in tables or field names:
- '*' for zero or more characters.
- '?' for one character.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFieldsOrColumnsWithWildcards` | `array` of [FieldOrColumn](#fieldorcolumn) | Yes | Pairs of table (optionally) and field names. Support wildcard matches. |
| `qMaxNumberOfValues` | `integer` | Yes | Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned. |
| `qRandSeed` | `integer` | No | Optional. Sets the random number seed. Should only be set for test purposes. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | `array` of [SampleResult](#sampleresult) | |
Properties of `qResult`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SampleResult` | [SampleResult](#sampleresult) | |
Properties of `SampleResult`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldOrColumn` | [FieldOrColumn](#fieldorcolumn) | |
| `qValues` | `array` of [FieldValue](#fieldvalue) | Matched values part of the sample. |
Properties of `qFieldOrColumn`
_Properties truncated due to depth limit._
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
---
### GetFieldDescription
Returns the description of a field.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFieldName` | `string` | Yes | Name of the field. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [FieldDescription](#fielddescription) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qInternalNumber` | `integer` | Internal number of the field. |
| `qName` | `string` | Name of the field. |
| `qSrcTables` | `array of string` | List of table names. |
| `qIsSystem` | `boolean` | If set to true, it means that the field is a system field. The default value is false. |
| `qIsHidden` | `boolean` | If set to true, it means that the field is hidden. The default value is false. |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. The default value is false. |
| `qDistinctOnly` | `boolean` | If set to true, only distinct field values are shown. The default value is false. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qTotalCount` | `integer` | Total number of field values. |
| `qPossibleCount_OBSOLETE` | `integer` | |
| `qHasInfo_OBSOLETE` | `boolean` | |
| `qIsLocked` | `boolean` | If set to true, it means that the field is locked. The default value is false. |
| `qAlwaysOneSelected` | `boolean` | If set to true, it means that the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false. |
| `qAndMode` | `boolean` | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. The default value is false. |
| `qComment` | `string` | Field comment. |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII. |
| `qIsDefinitionOnly` | `boolean` | If set to true, it means that the field is a field on the fly. The default value is false. |
| `qByteSize` | `integer` | Static RAM memory used in bytes. |
Properties of `qSrcTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### GetFieldOnTheFlyByName
Find the field-on-the-fly by passing its readable name.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qReadableName` | `string` | Yes | Readable name of the field-on-the-fly. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | |
---
### GetFieldsFromExpression
Retrives any fields from an expression.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qExpr` | `string` | Yes | Expression to get fields from. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFieldNames` | `array of string` | |
Properties of `qFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### GetFieldsResourceIds
Returns a list of resource ids (QRI) for fields that belongs to the datamodel.
Key fields (that belongs to multiple tables), returns one resource identifier per table.
GetFieldsResourceIds method is only supported in SaaS Editions of Qlik Sense.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFieldNames` | `array of string` | Yes | List of fields names that resource ids should be returned from. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFields` | `array` of [NxFieldResourceId](#nxfieldresourceid) | |
Properties of `qFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxFieldResourceId` | [NxFieldResourceId](#nxfieldresourceid) | |
Properties of `NxFieldResourceId`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field to get the resource id for. |
| `qResourceIds` | `array` of [NxFieldTableResourceId](#nxfieldtableresourceid) | Field level resource Id per table that the field is part of |
Properties of `qResourceIds`
**Array items:**
_Properties truncated due to depth limit._
---
### GetFileTableFields
**Access control:** `reload`
Lists the fields of a table for a folder connection.
**FileType**
Recognized file formats are:
* _CSV_ for Delimited
* _FIX_ for Fixed Record
* _DIF_ for Data Interchange Format
* _EXCEL_BIFF_ for Microsoft Excel (XLS)
* _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* _HTML_ for HTML
* _QVD_ for QVD file
* _XML_ for XML
* _QVX_ for QVX file
* _JSON_ for JSON format
* _KML_ for KML file
* _PARQUET_ for PARQUET file
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qRelativePath` | `string` | No | Path of the connection file. |
| `qDataFormat` | [FileDataFormat](#filedataformat) | Yes | Type of the file. |
| `qTable` | `string` | Yes | Name of the table. This parameter must be set for _XLS_ , _XLSX_ , _HTML _ and _XML_ files. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFields` | `array` of [DataField](#datafield) | |
| `qFormatSpec` | `string` | |
Properties of `qFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DataField` | [DataField](#datafield) | |
Properties of `DataField`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qIsKey` | `boolean` | Is set to true if the field is a primary key. |
| `qOriginalFieldName` | `string` | Is shown for fixed records. _qOriginalFieldName_ and _qName_ are identical if no field names are used in the file. _qOriginalFieldName_ differs from _qName_ if embedded file names are used in the file. |
---
### GetFileTablePreview
**Access control:** `reload`
Lists the values in a table for a folder connection.
**FileType**
Recognized file formats are:
* _CSV_ for Delimited
* _FIX_ for Fixed Record
* _DIF_ for Data Interchange Format
* _EXCEL_BIFF_ for Microsoft Excel (XLS)
* _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* _HTML_ for HTML
* _QVD_ for QVD file
* _XML_ for XML
* _QVX_ for QVX file
* _JSON_ for JSON format
* _KML_ for KML file
* _PARQUET_ for PARQUET file
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qRelativePath` | `string` | No | Path of the connection file. |
| `qDataFormat` | [FileDataFormat](#filedataformat) | Yes | Type of the file. |
| `qTable` | `string` | Yes | Name of the table. This parameter must be set for _XLS_ , _XLSX_ , _HTML _ and _XML_ files. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qPreview` | `array` of [DataRecord](#datarecord) | |
| `qFormatSpec` | `string` | |
Properties of `qPreview`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DataRecord` | [DataRecord](#datarecord) | |
Properties of `DataRecord`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array of string` | List of values inside the table. The first values (in _result/qPreview/0/qValues_ ) correspond to the field names in the table. The following values (from _result/qPreview/1/qValues_ ) are the values of the fields in the table. |
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
---
### GetFileTables
**Access control:** `reload`
Lists the tables for a folder connection.
**FileType**
Recognized file formats are:
* _CSV_ for Delimited
* _FIX_ for Fixed Record
* _DIF_ for Data Interchange Format
* _EXCEL_BIFF_ for Microsoft Excel (XLS)
* _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* _HTML_ for HTML
* _QVD_ for QVD file
* _XML_ for XML
* _QVX_ for QVX file
* _JSON_ for JSON format
* _KML_ for KML file
* _PARQUET_ for PARQUET file
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qRelativePath` | `string` | No | Path of the connection file. |
| `qDataFormat` | [FileDataFormat](#filedataformat) | Yes | Type of the file. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qTables` | `array` of [DataTable](#datatable) | |
Properties of `qTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DataTable` | [DataTable](#datatable) | |
Properties of `DataTable`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the table. |
| `qType` | `string` | Type of the table. For example: Table or View. |
---
### GetFileTablesEx
**Access control:** `reload`
Lists the tables and fields of a JSON or XML file for a folder connection.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qRelativePath` | `string` | No | Path of the connection file. |
| `qDataFormat` | [FileDataFormat](#filedataformat) | Yes | Type of the file. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qTables` | `array` of [DataTableEx](#datatableex) | |
Properties of `qTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DataTableEx` | [DataTableEx](#datatableex) | |
Properties of `DataTableEx`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the table. |
| `qFields` | `array` of [DataField](#datafield) | List of the fields in the table. |
| `qFormatSpec` | `string` | List of format specification items, within brackets. Examples of specification items: * file type * embedded labels, no labels * table is <table name> |
Properties of `qFields`
**Array items:**
_Properties truncated due to depth limit._
---
### GetFolderItemsForConnection
**Access control:** `reload`
Lists the items for a folder connection.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qRelativePath` | `string` | No | Relative path of the connection. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFolderItems` | `array` of [FolderItem](#folderitem) | |
Properties of `qFolderItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FolderItem` | [FolderItem](#folderitem) | |
Properties of `FolderItem`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the folder item. |
| `qType` | oneOf(FOLDER \| FILE \| OTHER) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
---
### GetGroupStates **[experimental]**
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qGroupStates` | `array` of [GroupState](#groupstate) | |
Properties of `qGroupStates`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GroupState` | [GroupState](#groupstate) | |
Properties of `GroupState`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qActiveFieldDef` | `string` | String defining the active field. |
Properties of `qInfo`
_Properties truncated due to depth limit._
---
### GetIncludeFileContent
**Access control:** `reload`
Gets the content of a file.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | ["lib://CONNECTION_NAME\\\<the name of the file you want to use>.txt"] OR ["lib://Connection_Name\\\<Folder under your connection>\\\<the name of the file you want to use>.txt"] [ ] should be used when the first variable contains a lib reference. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qContent` | `string` | |
---
### GetLibraryContent
Returns the content of a library.
**Global content library**
In Qlik Sense Desktop, the content files are retrieved from:
_%userprofile%\Documents\Qlik\Sense\Content\Default_
In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.
**App specific content library**
The embedded files are returned.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qName` | `string` | Yes | Name of the content library. It corresponds to the property _qContentLibraryListItem/qName_ returned by the _GetContentLibraries method_. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qList` | [StaticContentList](#staticcontentlist) | |
Properties of `qList`
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [StaticContentListItem](#staticcontentlistitem) | Information about the list of content files. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `StaticContentListItem` | [StaticContentListItem](#staticcontentlistitem) | In addition, this structure can return dynamic properties.
|
Properties of `StaticContentListItem`
_Properties truncated due to depth limit._
---
### GetLineage
**Access control:** `reload`
Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.
An array of lineage information.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qLineage` | `array` of [LineageInfo](#lineageinfo) | |
Properties of `qLineage`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `LineageInfo` | [LineageInfo](#lineageinfo) | |
Properties of `LineageInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qDiscriminator` | `string` | A string indicating the origin of the data: * [filename]: the data comes from a local file. * INLINE: the data is entered inline in the load script. * RESIDENT: the data comes from a resident table. The table name is listed. * AUTOGENERATE: the data is generated from the load script (no external table of data source). * Provider: the data comes from a data connection. The connector source name is listed. * [webfile]: the data comes from a web-based file. * STORE: path to QVD or TXT file where data is stored. * EXTENSION: the data comes from a Server Side Extension (SSE). |
| `qStatement` | `string` | The LOAD and SELECT script statements from the data load script. |
---
### GetLocaleInfo
Returns locale information.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [LocaleInfo](#localeinfo) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qDecimalSep` | `string` | Decimal separator. |
| `qThousandSep` | `string` | Thousand separator. |
| `qListSep` | `string` | List separator. |
| `qMoneyDecimalSep` | `string` | Money decimal separator. |
| `qMoneyThousandSep` | `string` | Money thousand separator. |
| `qCurrentYear` | `integer` | Current year. |
| `qMoneyFmt` | `string` | Money format. Example: _#.##0,00 kr;-#.##0,00 kr_ |
| `qTimeFmt` | `string` | Time format. Example: _hh:mm:ss_ |
| `qDateFmt` | `string` | Date format. Example: _YYYY-MM-DD_ |
| `qTimestampFmt` | `string` | Time stamp format. Example: _YYYY-MM-DD hh:mm:ss[.fff]_ |
| `qCalendarStrings` | [CalendarStrings](#calendarstrings) | |
| `qFirstWeekDay` | `integer` | First day of the week, starting from 0. According to ISO 8601, _Monday_ is the first day of the week. * 0 = Monday * 1 = Tuesday * ... * 6 = Sunday If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qBrokenWeeks` | `boolean` | Is set to true if broken weeks are allowed in a year. According to ISO 8601, no broken weeks should be allowed. This property is not shown if set to false. If _qBrokenWeeks_ is set to true, _qReferenceDay_ is irrelevant. If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qReferenceDay` | `integer` | Day in the year that is always in week 1. According to ISO 8601, January 4th should always be part of the first week of the year ( _qReferenceDay_ =4). Recommended values are in the range 1 and 7. If this property has not been set in a script, the returned value comes from the Windows operating system. This property is not relevant if there are broken weeks in the year. |
| `qFirstMonthOfYear` | `integer` | First month of the year, starting from 1. According to ISO 8601, _January_ is the first month of the year. * 1 = January * 2 = February * 12 = January If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qCollation` | `string` | Locale name (following language tagging convention RFC 4646): _< language>-<REGION>_ Where: * _language_ is a lowercase ISO 639 language code * _REGION_ specifies an uppercase ISO 3166 country code. If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qNumericalAbbreviation` | `string` | Number format. Example: 3:k;6:M;9:G;12:T;15:P;18:E;21:Z;24:Y;-3:m;-6:μ;-9:n;-12:p;-15:f;-18:a;-21:z;-24:y |
Properties of `qCalendarStrings`
| Name | Type | Description |
| --- | --- | --- |
| `qDayNames` | `array of string` | List of short day names. |
| `qMonthNames` | `array of string` | List of short month names. |
| `qLongDayNames` | `array of string` | List of long day names. |
| `qLongMonthNames` | `array of string` | List of long month names. |
Properties of `qDayNames`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMonthNames`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qLongDayNames`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qLongMonthNames`
**Array items:**
_Properties truncated due to depth limit._
---
### GetLooselyCoupledVector
Returns a list of table states.
The following states apply:
* 0 The table is not loosely coupled.
* 1 The table is loosely coupled.
* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.
The last three values in the vector are for internal use.
In case of circular references, the engine automatically sets the table state to loosely coupled to avoid creating loops.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `array of integer` | |
Properties of `qv`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### GetMatchingFields
Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.
Tags set by Qlik Sense are prefixed by the _$_ sign.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qTags` | `array of string` | Yes | List of tags. The _GetMatchingFields_ method looks for fields that match one or all of the tags in this list, depending on the value of _qMatchingFieldMode_ . |
| `qMatchingFieldMode` | `string` | No | Matching field mode. The default value is MATCHINGFIELDMODE_MATCH_ALL. One of: * MATCHINGFIELDMODE_MATCH_ALL * MATCHINGFIELDMODE_MATCH_ONE |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFieldNames` | `array` of [NxMatchingFieldInfo](#nxmatchingfieldinfo) | |
Properties of `qFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMatchingFieldInfo` | [NxMatchingFieldInfo](#nxmatchingfieldinfo) | |
Properties of `NxMatchingFieldInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qTags` | `array of string` | List of tags. |
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
---
### GetMeasure
Returns the handle of a measure.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the measure. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetMeasureWithLabel
Returns the handle of a measure with a label.
If multiple measures has the same label the first is returned.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qLabel` | `string` | Yes | is the label of the measure to be returned. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetMediaList _(deprecated)_
> **Deprecated:** Use _GetLibraryContent_ method instead
Lists the media files.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qList` | [MediaList](#medialist) | Lists the media files. Is the layout for _MediaListDef_. This struct is deprecated.
|
| `qReturn` | `boolean` | |
Properties of `qList`
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [MediaListItem](#medialistitem) | Information about the list of media files. In Qlik Sense Desktop, the media files are retrieved from: _%userprofile%\Documents\Qlik\Sense\Content\Default_ In Qlik Sense Enterprise, the media files are retrieved from: <installation_directory>\Qlik\Sense\Repository\Content\Default The default installation directory is _ProgramData_ . |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `MediaListItem` | [MediaListItem](#medialistitem) | In addition, this structure can return dynamic properties.
|
Properties of `MediaListItem`
_Properties truncated due to depth limit._
---
### GetObject
Returns the type of the app object and the corresponding handle.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the object to retrieve. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetObjects
Returns all objects compatible with options.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [NxGetObjectOptions](#nxgetobjectoptions) | Yes | Object type filter and requested properties. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qList` | `array` of [NxContainerEntry](#nxcontainerentry) | |
Properties of `qList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxContainerEntry` | [NxContainerEntry](#nxcontainerentry) | |
Properties of `NxContainerEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qMeta`
_Properties truncated due to depth limit._
---
### GetOrCreateObject **[experimental]**
**Access control:** `create`
Get or create a generic object at app level with a specific Id and Type.
Id and Type are specified in the GenericObjectProperties passed in.
All other fields in this parameter serve as default properties.
If the object does not exist with that Id, it is created and initialized from the default properties.
If the object already exists, it is not changed. The properties passed in are not used.
The call will fail if the Id is already used for another purpose, such as for an object of a different Type.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericObjectProperties](#genericobjectproperties) | Yes | GenericObjectProperties with at least Info : { "qId": "<identifier of the new generic object>", "qType": "<type of the new generic object>" } |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qNewObject` | `boolean` | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetScript
**Access control:** `reload`
Gets values in script.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qScript` | `string` | |
---
### GetScriptBreakpoints
**Access control:** `reload`
Lists the breakpoints in the script of an app.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qBreakpoints` | `array` of [EditorBreakpoint](#editorbreakpoint) | |
Properties of `qBreakpoints`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `EditorBreakpoint` | [EditorBreakpoint](#editorbreakpoint) | |
Properties of `EditorBreakpoint`
| Name | Type | Description |
| --- | --- | --- |
| `qbufferName` | `string` | Name of the breakpoint. |
| `qlineIx` | `integer` | Line number in the script where the breakpoint is set. |
| `qEnabled` | `boolean` | If set to true then the breakpoint is enabled (in use). |
---
### GetScriptEx
**Access control:** `read`
Gets script and script meta-data.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qScript` | [AppScript](#appscript) | |
Properties of `qScript`
| Name | Type | Description |
| --- | --- | --- |
| `qScript` | `string` | Script text. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qIsLocked` | `boolean` | True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### GetScriptMeta **[experimental]**
**Access control:** `read`
Gets script meta-data.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qMeta` | [AppScriptMeta](#appscriptmeta) | |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qIsLocked` | `boolean` | True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### GetSetAnalysis
Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.
| | BookmarkId empty | BookmarkId set |
|-----------------------|--------------------------------------|----------------------------------------------------|
|StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |
|StateName set | State selections is returned. | State in bookmark with id is returned. |
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStateName` | `string` | No | Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved. |
| `qBookmarkId` | `string` | No | Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSetExpression` | `string` | |
---
### GetTableData
Retrieves the data of a specific table.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOffset` | `integer` | Yes | Position from the top, starting from 0. If the offset is set to 0, the rows starting from the position/index 0 are shown. |
| `qRows` | `integer` | Yes | Number of rows to show. |
| `qSyntheticMode` | `boolean` | Yes | If this parameter is set to true, the internal data/table representation is shown. Synthetic fields are present (if any). |
| `qTableName` | `string` | Yes | Name of the table. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qData` | `array` of [TableRow](#tablerow) | |
Properties of `qData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableRow` | [TableRow](#tablerow) | |
Properties of `TableRow`
| Name | Type | Description |
| --- | --- | --- |
| `qValue` | `array` of [FieldValue](#fieldvalue) | Array of field values. |
Properties of `qValue`
**Array items:**
_Properties truncated due to depth limit._
---
### GetTableProfileData **[experimental]**
Returns profile data for a given table.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qTableName` | `string` | Yes | Name of the table |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProfiling` | [TableProfilingData](#tableprofilingdata) | |
Properties of `qProfiling`
| Name | Type | Description |
| --- | --- | --- |
| `qNoOfRows` | `integer` | Number of rows in the table. |
| `qFieldProfiling` | `array` of [FieldInTableProfilingData](#fieldintableprofilingdata) | Field values profiling info |
Properties of `qFieldProfiling`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldInTableProfilingData` | [FieldInTableProfilingData](#fieldintableprofilingdata) | |
Properties of `FieldInTableProfilingData`
_Properties truncated due to depth limit._
---
### GetTablesAndKeys
Returns:
* The list of tables in an app and the fields inside each table.
* The list of derived fields.
* The list of key fields.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qWindowSize` | [Size](#size) | Yes | Size of the window that is used to display the results. |
| `qNullSize` | [Size](#size) | Yes | |
| `qCellHeight` | `integer` | Yes | Height of a cell in a table in pixels. |
| `qSyntheticMode` | `boolean` | Yes | One of: * _true_ for internal table viewer: Shows a more detailed view on how the Qlik engine defines the relations between fields and the quality of the keys. * _false_ for source table viewer: Shows the natural relation between fields without reference to synthetic keys and resultant linking synthetic tables. Instead synthetic keys are represented by multiple connectors between tables. |
| `qIncludeSysVars` | `boolean` | Yes | If set to true, the system variables are included. |
| `qIncludeProfiling` | `boolean` | No | If set to true, profiling information is included. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qtr` | `array` of [TableRecord](#tablerecord) | |
| `qk` | `array` of [SourceKeyRecord](#sourcekeyrecord) | |
Properties of `qtr`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableRecord` | [TableRecord](#tablerecord) | |
Properties of `TableRecord`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the table. |
| `qLoose` | `boolean` | This property is set to true if the table is loose. |
| `qNoOfRows` | `integer` | Number of rows in the table. |
| `qFields` | `array` of [FieldInTableData](#fieldintabledata) | Information about the fields in the table. |
| `qPos` | [Point](#point) | |
| `qComment` | `string` | Comment related to the table. |
| `qIsDirectDiscovery` | `boolean` | If set to true, Direct Discovery is used. Direct Discovery fields are not loaded into memory and remain in the external database. |
| `qIsSynthetic` | `boolean` | This property is set to true if the table contains a synthetic key. |
| `qTableTags` | `array of string` | List of tags related to the table. |
| `qProfilingData` | [TableProfilingData](#tableprofilingdata) | |
Properties of `qFields`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qPos`
_Properties truncated due to depth limit._
Properties of `qTableTags`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qProfilingData`
_Properties truncated due to depth limit._
Properties of `qk`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SourceKeyRecord` | [SourceKeyRecord](#sourcekeyrecord) | |
Properties of `SourceKeyRecord`
| Name | Type | Description |
| --- | --- | --- |
| `qKeyFields` | `array of string` | Name of the key field. |
| `qTables` | `array of string` | Table the key belongs to. |
Properties of `qKeyFields`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTables`
**Array items:**
_Properties truncated due to depth limit._
---
### GetTextMacros
**Access control:** `reload`
Fetches updated variables after a statement execution.
If qRefSeqNo and qSetSeqNo are set to 0, it means that the variables were not updated.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qMacros` | `array` of [TextMacro](#textmacro) | |
Properties of `qMacros`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TextMacro` | [TextMacro](#textmacro) | |
Properties of `TextMacro`
| Name | Type | Description |
| --- | --- | --- |
| `qTag` | `string` | Name of the variable. |
| `qRefSeqNo` | `integer` | Order in which the variable was referenced during the script execution. The same number sequence is used for both _qRefSeqNo_ and _qSetSeqNo_ . |
| `qSetSeqNo` | `integer` | Order in which the variable was updated during the script execution. The same number sequence is used for both _qRefSeqNo_ and _qSetSeqNo_ . |
| `qDisplayString` | `string` | Variable value. |
| `qIsSystem` | `boolean` | Is set to true if the variable is a system variable. |
| `qIsReserved` | `boolean` | Is set to true if the variable is a reserved variable. |
---
### GetVariable _(deprecated)_
> **Deprecated:** Use _Doc::GetVariableById_ method or _Doc::GetVariableByName_ method instead
Returns a handle to a variable.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qName` | `string` | Yes | Name of the variable. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetVariableById
Gets the handle of a variable.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the variable. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetVariableByName
Gets the handle of a variable.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qName` | `string` | Yes | Name of the variable. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetVariables
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qListDef` | [VariableListDef](#variablelistdef) | Yes | |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qList` | `array` of [NxVariableListItem](#nxvariablelistitem) | |
Properties of `qList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxVariableListItem` | [NxVariableListItem](#nxvariablelistitem) | |
Properties of `NxVariableListItem`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the variable. |
| `qDescription` | `string` | Description of the variable. |
| `qDefinition` | `string` | Definition of the variable. It can be a value or an expression. |
| `qIsConfig` | `boolean` | If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false. |
| `qIsReserved` | `boolean` | If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples: * _ScriptError_ is a reserved variable, set by the engine. * _DayNames_ is a reserved variable, set by the user. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
| `qIsScriptCreated` | `boolean` | If set to true, it means that the variable was defined via script. |
Properties of `qMeta`
_Properties truncated due to depth limit._
Properties of `qInfo`
_Properties truncated due to depth limit._
---
### GetViewDlgSaveInfo
Returns information about the position of the tables in the data model viewer.
The position of the broom points and the position of the connection points cannot be retrieved in Qlik Sense.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [TableViewDlgSaveInfo](#tableviewdlgsaveinfo) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qPos` | [Rect](#rect) | |
| `qCtlInfo` | [TableViewCtlSaveInfo](#tableviewctlsaveinfo) | |
| `qMode` | `integer` | View mode to display when opening Qlik Sense data model viewer. One of: * 0 for internal view mode. * 1 for source view mode. |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
Properties of `qCtlInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qInternalView` | [TableViewSaveInfo](#tableviewsaveinfo) | |
| `qSourceView` | [TableViewSaveInfo](#tableviewsaveinfo) | |
Properties of `qInternalView`
_Properties truncated due to depth limit._
Properties of `qSourceView`
_Properties truncated due to depth limit._
---
### GuessFileType
**Access control:** `reload`
Guesses the data format for a given file.
Recognized file formats are:
* _CSV_ for Delimited
* _FIX_ for Fixed Record
* _DIF_ for Data Interchange Format
* _EXCEL_BIFF_ for Microsoft Excel (XLS)
* _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* _HTML_ for HTML
* _QVD_ for QVD file
* _XML_ for XML
* _QVX_ for QVX file
* _JSON_ for JSON format
* _KML_ for KML file
* _PARQUET_ for PARQUET file
**FileType**
Recognized file formats are:
* _CSV_ for Delimited
* _FIX_ for Fixed Record
* _DIF_ for Data Interchange Format
* _EXCEL_BIFF_ for Microsoft Excel (XLS)
* _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* _HTML_ for HTML
* _QVD_ for QVD file
* _XML_ for XML
* _QVX_ for QVX file
* _JSON_ for JSON format
* _KML_ for KML file
* _PARQUET_ for PARQUET file
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection file. |
| `qRelativePath` | `string` | No | Path of the connection file. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDataFormat` | [FileDataFormat](#filedataformat) | ### FileType Recognized file formats are: * _CSV_ for Delimited * _FIX_ for Fixed Record * _DIF_ for Data Interchange Format * _EXCEL_BIFF_ for Microsoft Excel (XLS) * _EXCEL_OOXML_ for Microsoft Excel (XLSX) * _HTML_ for HTML * _QVD_ for QVD file * _XML_ for XML * _QVX_ for QVX file * _JSON_ for JSON format * _KML_ for KML file * _PARQUET_ for PARQUET file |
Properties of `qDataFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(CSV \| FIX \| DIF \| EXCEL_BIFF \| EXCEL_OOXML \| HTML \| QVD \| XML \| QVX \| JSON \| KML \| PARQUET) | |
| `qLabel` | `string` | One of: * Embedded labels (field names are present in the file) * No labels * Explicit labels (for DIFfiles) |
| `qQuote` | `string` | One of: * None (no quotes) * MSQ (Modern Style Quoting) * Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value) This property is used for delimited files. |
| `qComment` | `string` | String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files. |
| `qDelimiter` | [DelimiterInfo](#delimiterinfo) | |
| `qCodePage` | `integer` | Character set used in the file. |
| `qHeaderSize` | `integer` | Size of the header. Example: If the header size is 2, the first two rows in the file are considered as header and not as data. The header can contain the field names. |
| `qRecordSize` | `integer` | Record length. Each record (row of data) contains a number of columns with a fixed field size. This property is used for fixed record data files. |
| `qTabSize` | `integer` | Number of spaces that one tab character represents in the table file. This property is used for fixed record data files. |
| `qIgnoreEOF` | `boolean` | Is set to true, the end-of-file character is not taken into account during reload. This property is used for delimited files and fixed record data files. |
| `qFixedWidthDelimiters` | `string` | Positions of the field breaks in the table. This property is used for fixed record data files. |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `CSV` | `object` | FILE_TYPE_CSV |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FIX` | `object` | FILE_TYPE_FIX |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DIF` | `object` | FILE_TYPE_DIF |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `EXCEL_BIFF` | `object` | FILE_TYPE_EXCEL_BIFF |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `EXCEL_OOXML` | `object` | FILE_TYPE_EXCEL_OOXML |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `HTML` | `object` | FILE_TYPE_HTML |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `QVD` | `object` | FILE_TYPE_QVD |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `XML` | `object` | FILE_TYPE_XML |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `QVX` | `object` | FILE_TYPE_QVX |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `JSON` | `object` | FILE_TYPE_JSON |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `KML` | `object` | FILE_TYPE_KML |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `PARQUET` | `object` | FILE_TYPE_PARQUET |
Properties of `qDelimiter`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the delimiter. Example: "Tab_DELIMITER" |
| `qScriptCode` | `string` | Representation of the delimiter value that is used in the script. Example: "'\t'" |
| `qNumber` | `integer` | Delimiter character number used by the engine to determine how to separate the values. |
| `qIsMultiple` | `boolean` | Is set to true if multiple spaces are used to separate the values. |
---
### LockAll
Locks all selections in fields for current state.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStateName` | `string` | No | Alternate state name. When set, applies to alternate state instead of current. |
**Returns:** `object`
---
### ModifyConnection
**Access control:** `update`
Updates a connection.
The identifier of a connection cannot be updated. qType cannot be modified with the ModifyConnection method.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnectionId` | `string` | Yes | Identifier of the connection. |
| `qConnection` | [Connection](#connection) | Yes | Information about the connection. Properties that can be updated. |
| `qOverrideCredentials` | `boolean` | No | Set this parameter to true to override the user name and password. |
**Returns:** `object`
---
### Publish
**Access control:** `publish`
Publishes an app.
All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.
An app can only be published once and cannot be published to more than one stream.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStreamId` | `string` | Yes | Identifier of the stream. |
| `qName` | `string` | No | Name of the published app. If this parameter is not set, the engine automatically gives a new name to the published app. |
**Returns:** `object`
---
### Redo
Redoes the previous operation.
The operation is successful if **qSuccess** is set to true.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### RemoveAlternateState
**Access control:** `update`
Removes an alternate state in the app.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStateName` | `string` | Yes | Name of the alternate state. |
**Returns:** `object`
---
### RemoveSessionAlternateState
Removes an session alternate state in the app.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStateName` | `string` | Yes | Name of the alternate state. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### RemoveVariable _(deprecated)_
> **Deprecated:** Use _Doc::DestroyVariableById_ method or _Doc::DestroyVariableByName_ method instead
**Access control:** `update`
Removes a variable.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qName` | `string` | Yes | Name of the variable. Variable names are case sensitive. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### ReplaceBookmark
**Access control:** `update`
Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the bookmark. |
| `qIgnorePatches` | `boolean` | No | Set to true to exclude patches from the bookmark. Default is false. |
| `qObjectIdsToPatch` | `array of string` | No | Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. Ignored if IgnorePatches is set to true. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### RestoreTempSelectionState
Restore a temporary selection state identified by Id.
RestoreTempSelectionState method is only supported in SaaS Editions of Qlik Sense.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the temporary selection state |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### Resume
Resumes the app as the user left it.
**Returns:** `object`
---
### SaveAs
**Access control:** `create`
Save a copy of an app with a different name.
Can be used to save a session app as an ordinary app.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qNewAppName` | `string` | Yes | <Name of the saved app> |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qNewAppId` | `string` | |
---
### SaveObjects
**Access control:** `update`
Saves all objects that were modified in the app.
Data from the data model are not saved.
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### Scramble
**Access control:** `update`
Scrambles a field so the data is not recognizable. Some properties are retained to help debugging. For example, special characters are not changed, and small numbers are scrambled to another small number.
Update access is required to use the function in Qlik Sense Enterprise.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFieldName` | `string` | Yes | Name of the field to scramble. |
**Returns:** `object`
---
### SearchAssociations _(deprecated)_
> **Deprecated:** Use _SearchResults_ method instead
Returns the search matches for one or more search terms.
The search results depend on the search context.
_SearchCombinationOptions_
**SearchMatchCombinations**
| Name |
Description |
Type |
| qSearchMatchCombinations |
Array of search combinations. |
Array of SearchMatchCombination |
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [SearchCombinationOptions](#searchcombinationoptions) | Yes | Information about the search fields and the search context. |
| `qTerms` | `array of string` | Yes | List of terms to search for. |
| `qPage` | [SearchPage](#searchpage) | Yes | Array of pages to retrieve. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResults` | [SearchAssociationResult](#searchassociationresult) | |
Properties of `qResults`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldNames` | `array of string` | List of the fields that contains search associations. |
| `qSearchTerms` | `array of string` | List of the search terms. |
| `qFieldDictionaries` | `array` of [SearchFieldDictionary](#searchfielddictionary) | Information about the fields containing search hits. |
| `qSearchTermsMatched` | `array` of [SearchMatchCombinations](#searchmatchcombinations) | List of search results. The maximum number of search results in this list is set by _qPage/qCount_ . |
| `qTotalSearchResults` | `integer` | Total number of search results. This number is not limited by _qPage/qCount_ . |
Properties of `qFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSearchTerms`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldDictionaries`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchFieldDictionary` | [SearchFieldDictionary](#searchfielddictionary) | |
Properties of `SearchFieldDictionary`
_Properties truncated due to depth limit._
Properties of `qSearchTermsMatched`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchMatchCombinations` | [SearchMatchCombinations](#searchmatchcombinations) | |
Properties of `SearchMatchCombinations`
**Array items:**
_Properties truncated due to depth limit._
---
### SearchObjects
Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: _slideitem_ , _sheet_ , _story_ , _slide_ , _masterobject_ , _snapshot_ , _LoadModel_ , _appprops_ and _searchhistory_ .
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [SearchObjectOptions](#searchobjectoptions) | Yes | Information about attributes. |
| `qTerms` | `array of string` | Yes | Terms to search for. |
| `qPage` | [SearchPage](#searchpage) | Yes | Array of pages to retrieve. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [SearchResult](#searchresult) | |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qSearchTerms` | `array of string` | List of the search terms. |
| `qTotalNumberOfGroups` | `integer` | Total number of groups. |
| `qSearchGroupArray` | `array` of [SearchGroup](#searchgroup) | List of search groups. The groups are numbered from the value of _SearchPage.qOffset_ to the value of _SearchPage.qOffset + SearchPage.qCount_ . |
Properties of `qSearchTerms`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSearchGroupArray`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroup` | [SearchGroup](#searchgroup) | |
Properties of `SearchGroup`
_Properties truncated due to depth limit._
---
### SearchResults
Returns the search matches for one or more search terms.
Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).
Each search group contains search results that correspond to a combination of search terms.
For example, if the search terms are _organic_ , _pasta_ , and _America_ , the possible combination of search groups are:
* organic
* pasta
* America
* organic, pasta, America
* organic, pasta
* organic, America
* pasta, America
For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).
For every search group item, there are one or several search matches. The position of the match in each search result is given.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [SearchCombinationOptions](#searchcombinationoptions) | Yes | Information about the search combinations. |
| `qTerms` | `array of string` | Yes | Terms to search for. |
| `qPage` | [SearchPage](#searchpage) | Yes | Array of pages to retrieve. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [SearchResult](#searchresult) | |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qSearchTerms` | `array of string` | List of the search terms. |
| `qTotalNumberOfGroups` | `integer` | Total number of groups. |
| `qSearchGroupArray` | `array` of [SearchGroup](#searchgroup) | List of search groups. The groups are numbered from the value of _SearchPage.qOffset_ to the value of _SearchPage.qOffset + SearchPage.qCount_ . |
Properties of `qSearchTerms`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSearchGroupArray`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroup` | [SearchGroup](#searchgroup) | |
Properties of `SearchGroup`
_Properties truncated due to depth limit._
---
### SearchSuggest
Returns search terms suggestions.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [SearchCombinationOptions](#searchcombinationoptions) | Yes | Information about the search combinations. |
| `qTerms` | `array of string` | Yes | Terms to search for. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [SearchSuggestionResult](#searchsuggestionresult) | |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qSuggestions` | `array` of [SearchSuggestItem](#searchsuggestitem) | List of suggestions. |
| `qFieldNames` | `array of string` | List of field names that contain search hits. |
Properties of `qSuggestions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchSuggestItem` | [SearchSuggestItem](#searchsuggestitem) | |
Properties of `SearchSuggestItem`
_Properties truncated due to depth limit._
Properties of `qFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### SearchValues **[experimental]**
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [SearchValueOptions](#searchvalueoptions) | Yes | |
| `qTerms` | `array of string` | Yes | |
| `qPage` | [SearchValuePage](#searchvaluepage) | Yes | |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [SearchValueResult](#searchvalueresult) | |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qSearchTerms` | `array of string` | List of the search terms. |
| `qFieldMatches` | `array` of [SearchFieldValueItem](#searchfieldvalueitem) | List of search groups. The groups are numbered from the value of _SearchPage.qOffset_ to the value of _SearchPage.qOffset + SearchPage.qCount_ . |
Properties of `qSearchTerms`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldMatches`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchFieldValueItem` | [SearchFieldValueItem](#searchfieldvalueitem) | |
Properties of `SearchFieldValueItem`
_Properties truncated due to depth limit._
---
### SelectAssociations
Selects all search hits for a specified group.
The results depend on the search context.
_SearchCombinationOptions_.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qOptions` | [SearchCombinationOptions](#searchcombinationoptions) | Yes | Information about the search fields and the search context. |
| `qTerms` | `array of string` | Yes | List of terms to search for. |
| `qMatchIx` | `integer` | Yes | Index (value of _qId_ ) of the search result to select. |
| `qSoftLock` | `boolean` | No | This parameter is deprecated and should not be set. |
**Returns:** `object`
---
### SendGenericCommandToCustomConnector
**Access control:** `reload`
Sends a generic command to a custom connector.
For more information on the commands that can be sent to a custom connector, see the QVX SDK help.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProvider` | `string` | Yes | Connector file name. Command to be executed by the connector. |
| `qCommand` | `string` | Yes | One of: * JsonRequest * GetCustomCaption * IsConnected * DisableQlikViewSelectButton * HaveStarField |
| `qMethod` | `string` | Yes | Method name to be used within the command. The available methods depend on the chosen connector. |
| `qParameters` | `array of string` | Yes | Parameters of the command. No parameters are required. |
| `qAppendConnection` | `string` | Yes | Name of the connection. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | `string` | |
---
### SetAppProperties
**Access control:** `update`
Sets properties to an app.
The qLastReloadTime, qMigrationHash and qSavedInProductVersion properties does not need to be set but if they are, they should match the current values in the app layout.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [NxAppProperties](#nxappproperties) | Yes | Information about the properties of an app. |
**Returns:** `object`
---
### SetFavoriteVariables
**Access control:** `reload`
Set some variables as favorite.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qNames` | `array of string` | Yes | Variables to set as favorite. |
**Returns:** `object`
---
### SetFetchLimit
**Access control:** `reload`
Limits the number of rows of data to load from a data source.
This method works when reloading in debug mode.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qLimit` | `integer` | Yes | Fetch limit. Number of rows to load. |
**Returns:** `object`
---
### SetLooselyCoupledVector
**Access control:** `reload`
Sets a list of table states, one for each table.
The following states apply:
* 0 The table is not loosely coupled.
* 1 The table is loosely coupled.
* 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API.
The last three values in the vector are for internal use.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qv` | `array of integer` | Yes | The list of table states to set. A state will not be changed if already set to 2. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### SetProhibitBinaryLoad
**Access control:** `update`
Prohibit binary load of this app.
An app with prohibit binary load set cannot be loaded binary. For the setting to have effect a save is required.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProhibit` | `boolean` | Yes | True or false. |
**Returns:** `object`
---
### SetScript
**Access control:** `update`
Sets values in script.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qScript` | `string` | Yes | Script content. |
**Returns:** `object`
---
### SetScriptBreakpoints
**Access control:** `reload`
Set some breakpoints in the script of an app.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qBreakpoints` | `array` of [EditorBreakpoint](#editorbreakpoint) | Yes | Information about the breakpoints. |
**Returns:** `object`
---
### SetViewDlgSaveInfo
**Access control:** `update`
Sets the positions of the tables in the data model viewer.
The position of the broom points and the position of the connection points cannot be set in Qlik Sense.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qInfo` | [TableViewDlgSaveInfo](#tableviewdlgsaveinfo) | Yes | Information about the table. |
**Returns:** `object`
---
### StoreTempSelectionState
Store current selection state temporarily.
The temporary selection state will be stored for 30min by default if TTL parameter is not present or positive.
StoreTempSelectionState method is only supported in SaaS Editions of Qlik Sense.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qTTLOfTempState` | `integer` | No | Time to live in seconds for stored selection state |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qReturn` | `boolean` | |
---
### TransformApp
Transform current app into an instance of the targeted mode
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qDstParameters` | [TransformAppParameters](#transformappparameters) | Yes | Attributes that should be set in the new app. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [TransformAppResult](#transformappresult) | |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qAppId` | `string` | ID of created App |
---
### Undo
Undoes the previous operation.
The operation is successful if **qSuccess** is set to true.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### UnlockAll
Unlocks all selections in fields for current state.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStateName` | `string` | No | Alternate state name. When set, applies to alternate state instead of current. |
**Returns:** `object`
---
## Field
### Clear
Clears the selections in a specific field.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### ClearAllButThis
Maintains the selections in the current field while clearing the selections in the other fields.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Clear the selections in all fields except the current field
---
### GetAndMode
Returns the AND mode status of a field.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- [SetAndMode method](#setandmode)
- Select values in a field
---
### GetCardinal
Retrieves the number of distinct values in a field.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `integer` | |
**See also:**
- Get the number of distinct values of a field
---
### GetNxProperties
Gets the properties of a field.
The property _OneAndOnlyOne_ is set to true if one and only value has been selected in the field prior setting the property.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProperties` | [NxFieldProperties](#nxfieldproperties) | |
Properties of `qProperties`
| Name | Type | Description |
| --- | --- | --- |
| `qOneAndOnlyOne` | `boolean` | This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The property _OneAndOnlyOne_ can be set to true if one and only value has been selected in the field prior to setting the property.
|
**See also:**
- Get the properties of a field
---
### Lock
Locks all selected values of a specific field.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### LowLevelSelect
Selects some values in a field, by entering the element numbers related to the values to select.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qValues` | `array of integer` | Yes | Indexes (or element numbers) of the values to select. |
| `qToggleMode` | `boolean` | Yes | Set to true to keep any selections present in the list object. If this parameter is set to false, selections made before accepting the list object search become alternative. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### Select
Selects field values matching a search string.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qMatch` | `string` | Yes | String to search for. Can contain wild cards or numeric search criteria. The characters <>"~()='[] have pre-defined meanings when used at the start of the string. To use them, EnableSpecialCharacterEscapingInSearch needs to be enabled and the delimiter \ needs to precede the special character. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
| `qExcludedValuesMode` | `integer` | No | Include excluded values in search. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### SelectAll
Selects all values of a field. Excluded values are also selected.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Select all values of a field
- Create and apply a bookmark
- Clear the selections of a specific field
---
### SelectAlternative
Selects all alternatives values in a specific field.
In a field that contains at least one selected value, the values that are neither selected nor excluded are alternatives values.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Select all alternative values of a field
---
### SelectExcluded
Inverts the current selections.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Invert the current selections
---
### SelectPossible
Selects all possible values in a specific field.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Select all possible values of a field
---
### SelectValues
Selects some values in a field, by entering the values to select.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFieldValues` | `array` of [FieldValue](#fieldvalue) | Yes | List of the values to select. |
| `qToggleMode` | `boolean` | No | The default value is false. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Select values in a field
---
### SetAndMode
Sets a field in the AND mode.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qAndMode` | `boolean` | Yes | Specifies if the AND mode applies to the field. Set this parameter to true to enter the AND mode. |
**Returns:** `object`
**See also:**
- [GetAndMode method](#getandmode)
---
### SetNxProperties
Sets some properties to a field.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProperties` | [NxFieldProperties](#nxfieldproperties) | Yes | Information about the properties of the field. |
**Returns:** `object`
**See also:**
- Set the properties of a field
---
### ToggleSelect
Toggle selects field values matching a search string.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qMatch` | `string` | Yes | String to search for. Can contain wild cards or numeric search criteria. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
| `qExcludedValuesMode` | `integer` | No | Include excluded values in search. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Toggle select values of a field
---
### Unlock
Unlocks all selected values of a specific field if the target (or handle ) is a field.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
## GenericBookmark
### Apply
Applies a bookmark.
The operation is successful if **qSuccess** is set to true.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Apply a bookmark
---
### ApplyAndVerify **[experimental]**
Applies a bookmark and verify result dataset against originally selected values.
The operation is successful if **qApplySuccess** is set to true. **qWarnings** lists state and field with unmatching values
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qResult` | [BookmarkApplyAndVerifyResult](#bookmarkapplyandverifyresult) | |
Properties of `qResult`
| Name | Type | Description |
| --- | --- | --- |
| `qApplySuccess` | `boolean` | Apply successfully or not * |
| `qWarnings` | `array` of [BookmarkFieldVerifyWarning](#bookmarkfieldverifywarning) | Field values verfication result * |
| `qGroupStateResult` | [ApplyGroupStatesResult](#applygroupstatesresult) | Result of applying GroupState to multiple cyclic groups. |
Properties of `qWarnings`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkFieldVerifyWarning` | [BookmarkFieldVerifyWarning](#bookmarkfieldverifywarning) | |
Properties of `BookmarkFieldVerifyWarning`
_Properties truncated due to depth limit._
Properties of `qGroupStateResult`
| Name | Type | Description |
| --- | --- | --- |
| `qApplySuccess` | `boolean` | When true, the operation was successful. |
| `qWarnings` | `array` of [ApplyGroupStateWarning](#applygroupstatewarning) | Lists which states failed to be applied and why. |
Properties of `qWarnings`
**Array items:**
_Properties truncated due to depth limit._
**See also:**
- Apply a bookmark
---
### ApplyPatches
**Access control:** `update`
Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",
and it will be forbidden in the near future.
Applying a patch takes less time than resetting all the properties.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPatches` | `array` of [NxPatch](#nxpatch) | Yes | Array of patches. |
**Returns:** `object`
**See also:**
- Add some properties to an object
- Remove some properties
- Update some properties of an object
---
### Approve
**Access control:** `approve`
Adds the generic bookmark to the list of approved objects
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### GetFieldValues
Retrieves the values of a field for the default state.
**Fieldvalue**
| Name |
Description |
Type |
| qText |
Text related to the field value. |
String |
| qIsNumeric |
Is set to true if the value is a numeric.
Default is false. |
Boolean |
| qNumber |
Numeric value of the field.
This parameter is displayed if qIsNumeric is set to true. |
Double |
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qField` | `string` | Yes | Name of the field. |
| `qGetExcludedValues` | `boolean` | Yes | If set to true, only NOT-selected values are returned. |
| `qDataPage` | [BookmarkFieldPage](#bookmarkfieldpage) | Yes | Range of returned values. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFieldValues` | `array` of [FieldValue](#fieldvalue) | |
Properties of `qFieldValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldValue` | [FieldValue](#fieldvalue) | |
Properties of `FieldValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
**See also:**
- Get the handle of a field
---
### GetFieldValuesEx
Retrieves the values of a field per state.
**Fieldvalue**
| Name |
Description |
Type |
| qText |
Text related to the field value. |
String |
| qIsNumeric |
Is set to true if the value is a numeric.
Default is false. |
Boolean |
| qNumber |
Numeric value of the field.
This parameter is displayed if qIsNumeric is set to true. |
Double |
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qField` | `string` | Yes | Name of the field. |
| `qGetExcludedValues` | `boolean` | Yes | When to true, only NOT-selected values are returned. |
| `qDataPages` | [BookmarkStateFieldPages](#bookmarkstatefieldpages) | Yes | Range of returned values per state, an empty array will return the values of all states. Only one page without a state name returns the values for all states, using the start and end indices of the first page. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFieldValues` | `array` of [StateFieldValues](#statefieldvalues) | |
Properties of `qFieldValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `StateFieldValues` | [StateFieldValues](#statefieldvalues) | |
Properties of `StateFieldValues`
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the state. |
| `qFieldValues` | `array` of [FieldValue](#fieldvalue) | The field values associated with the state. |
Properties of `qFieldValues`
**Array items:**
_Properties truncated due to depth limit._
**See also:**
- Get the handle of a field
---
### GetInfo
Returns:
* The type of the object.
* The identifier of the object.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### GetLayout
Evaluates an object and displays its properties including the dynamic properties.
If the member _delta_ is set to true in the request object, only the delta is evaluated.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qLayout` | [GenericBookmarkLayout](#genericbookmarklayout) | Is the layout for _GenericBookmarkProperties_. |
Properties of `qLayout`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qBookmark` | [NxBookmark](#nxbookmark) | |
| `qFieldInfos` | `array` of [LayoutFieldInfo](#layoutfieldinfo) | Information about the field selections associated with the bookmark. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qBookmark`
| Name | Type | Description |
| --- | --- | --- |
| `qStateData` | `array` of [AlternateStateData](#alternatestatedata) | List of selections for each state. |
| `qUtcModifyTime` | `number` | Time when the bookmark was created. |
| `qVariableItems` | `array` of [BookmarkVariableItem](#bookmarkvariableitem) | List of the variables in the app at the time the bookmark was created. |
| `qPatches` | `array` of [NxPatches](#nxpatches) | Softpatches to be applied with this bookmark. |
| `qCyclicGroupStates` | `array` of [CyclicGroupPosition](#cyclicgroupposition) | Information about cyclic groups by zero-based index. This field is unused. |
| `qGroupStates` | `array` of [GroupState](#groupstate) | Information about cyclic groups indexed by field definition. |
Properties of `qStateData`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qVariableItems`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qPatches`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCyclicGroupStates`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qGroupStates`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qFieldInfos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `LayoutFieldInfo` | [LayoutFieldInfo](#layoutfieldinfo) | Meta data about the selection in a field. |
Properties of `LayoutFieldInfo`
_Properties truncated due to depth limit._
**See also:**
- Get the layout of a bookmark
- List the dimensions in an app
- List the fields in an app
- List the measures in an app
- Get the delta of the layout
- Get the layout of a generic object
---
### GetProperties
Shows the properties of an object.
If the member delta is set to true in the request object, only the delta is retrieved.
The following is always returned in the output:
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProp` | [GenericBookmarkProperties](#genericbookmarkproperties) | |
Properties of `qProp`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qIncludeVariables` | `boolean` | If true all variables will be stored in the bookmark. |
| `qDistinctValues` | `boolean` | If true all selected values will be stored distinct, i.e. searchstrings will not be kept. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
**See also:**
- Set the properties of a bookmark
- Get the delta of properties
- Get the properties of an object
- Set the properties of an object
---
### Publish
**Access control:** `publish`
Publishes a bookmark.
This operation is not applicable for Qlik Sense Desktop.
**Returns:** `object`
**See also:**
- Publish a bookmark
- Publish an app to a stream
- Publish a dimension
- Publish a generic object
- Publish a measure
---
### SetProperties
**Access control:** `update`
Sets some properties for a bookmark.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericBookmarkProperties](#genericbookmarkproperties) | Yes | Information about the bookmark. |
**Returns:** `object`
**See also:**
- Set the properties of a bookmark
- Set the properties of an object
- [SetFullPropertyTree method](#setfullpropertytree)
---
### UnApprove
**Access control:** `approve`
Removes the generic bookmark from the list of approved objects
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### UnPublish
**Access control:** `publish`
Unpublishes a bookmark.
This operation is not applicable for Qlik Sense Desktop.
**Returns:** `object`
---
## GenericDimension
### ApplyPatches
**Access control:** `update`
Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",
and it will be forbidden in the near future.
Applying a patch takes less time than resetting all the properties.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPatches` | `array` of [NxPatch](#nxpatch) | Yes | Array of patches. |
**Returns:** `object`
**See also:**
- Add some properties to an object
- Remove some properties
- Update some properties of an object
---
### Approve
**Access control:** `approve`
Adds the generic dimension to the list of approved objects
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### GetActiveField **[experimental]**
Get a cyclic dimension's active field.
This operation is only possible for cyclic dimensions.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `integer` | |
---
### GetDimension
Returns the definition of a dimension.
The definition of the dimension is returned.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDim` | [NxLibraryDimensionDef](#nxlibrarydimensiondef) | |
Properties of `qDim`
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of dimension names. |
| `qFieldLabels` | `array of string` | Array of dimension labels. |
| `qLabelExpression` | `string` | |
| `qAlias` | `string` | Alias of the dimension. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### GetInfo
Returns the type and identifier of the object.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### GetLayout
Evaluates a dimension and displays its properties, including the dynamic properties.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qLayout` | [GenericDimensionLayout](#genericdimensionlayout) | Is the layout for _GenericDimensionProperties_. |
Properties of `qLayout`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qDim` | [NxLibraryDimension](#nxlibrarydimension) | |
| `qDimInfos` | `array` of [GenericDimensionInfo](#genericdimensioninfo) | Cardinal and tags related to the dimension. Length of the longest value in the field. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qDim`
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of dimension names. |
| `qFieldLabels` | `array of string` | Array of dimension labels. |
| `qLabelExpression` | `string` | |
| `qAlias` | `string` | Alias of the dimension. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qFieldDefs`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qFieldLabels`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qDimInfos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericDimensionInfo` | [GenericDimensionInfo](#genericdimensioninfo) | |
Properties of `GenericDimensionInfo`
_Properties truncated due to depth limit._
**See also:**
- Get the layout of a dimension
---
### GetLinkedObjects
Lists the linked objects to a generic object, a dimension or a measure.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxLinkedObjectInfo](#nxlinkedobjectinfo) | |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxLinkedObjectInfo` | [NxLinkedObjectInfo](#nxlinkedobjectinfo) | |
Properties of `NxLinkedObjectInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qRootId` | `string` | Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object. |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
_Properties truncated due to depth limit._
---
### GetProperties
Shows the properties of an object.
Returns the identifier and the definition of the dimension.
If the member delta is set to true in the request object, only the delta is retrieved.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProp` | [GenericDimensionProperties](#genericdimensionproperties) | |
Properties of `qProp`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qDim` | [NxLibraryDimensionDef](#nxlibrarydimensiondef) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qDim`
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of dimension names. |
| `qFieldLabels` | `array of string` | Array of dimension labels. |
| `qLabelExpression` | `string` | |
| `qAlias` | `string` | Alias of the dimension. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qFieldDefs`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qFieldLabels`
**Array items:**
_Properties truncated due to depth limit._
**See also:**
- Set the properties of a bookmark
- Get the delta of properties
- Get the properties of an object
- Set the properties of an object
---
### Publish
**Access control:** `publish`
Publishes a dimension.
This operation is not applicable for Qlik Sense Desktop.
**Returns:** `object`
**See also:**
- Publish a bookmark
- Publish an app to a stream
- Publish a dimension
- Publish a generic object
- Publish a measure
---
### SetActiveField **[experimental]**
Set a cyclic dimension's active field directly.
This operation is only possible for cyclic dimensions.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qIx` | `integer` | Yes | Index of the new active field. |
**Returns:** `object`
---
### SetProperties
**Access control:** `update`
Sets some properties for a dimension.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericDimensionProperties](#genericdimensionproperties) | Yes | Information about the dimension. |
**Returns:** `object`
**See also:**
- Set the properties of a bookmark
- Set the properties of an object
- [SetFullPropertyTree method](#setfullpropertytree)
---
### StepCycle **[experimental]**
Step active field in a cyclic dimension.
This operation is only possible for cyclic dimensions.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qStep` | `integer` | Yes | The number of steps made through the dimension. Positive values step forward and negative values step backward. |
**Returns:** `object`
---
### UnApprove
**Access control:** `approve`
Removes the generic dimension from the list of approved objects
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### UnPublish
**Access control:** `publish`
Unpublishes a dimension.
This operation is not applicable for Qlik Sense Desktop.
**Returns:** `object`
---
## GenericMeasure
### ApplyPatches
**Access control:** `update`
Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",
and it will be forbidden in the near future.
Applying a patch takes less time than resetting all the properties.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPatches` | `array` of [NxPatch](#nxpatch) | Yes | Array of patches. |
**Returns:** `object`
**See also:**
- Add some properties to an object
- Remove some properties
- Update some properties of an object
---
### Approve
**Access control:** `approve`
Adds the generic measure to the list of approved objects
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### GetInfo
Returns the type and identifier of the object.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### GetLayout
Evaluates a measure and displays its properties, including the dynamic properties.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qLayout` | [GenericMeasureLayout](#genericmeasurelayout) | Is the layout for _GenericMeasureProperties_. |
Properties of `qLayout`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeasure` | [NxLibraryMeasure](#nxlibrarymeasure) | Information about the library measure. Is the layout for _NxLibraryMeasureDef_. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeasure`
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | |
| `qDef` | `string` | |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qExpressions` | `array of string` | |
| `qActiveExpression` | `integer` | |
| `qLabelExpression` | `string` | |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qExpressions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
**See also:**
- Get the layout of a measure
---
### GetLinkedObjects
Lists the linked objects to a generic object, a dimension or a measure.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxLinkedObjectInfo](#nxlinkedobjectinfo) | |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxLinkedObjectInfo` | [NxLinkedObjectInfo](#nxlinkedobjectinfo) | |
Properties of `NxLinkedObjectInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qRootId` | `string` | Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object. |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
_Properties truncated due to depth limit._
---
### GetMeasure
Returns the definition of a measure.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qMeasure` | [NxLibraryMeasureDef](#nxlibrarymeasuredef) | |
Properties of `qMeasure`
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | Label of the measure. |
| `qDef` | `string` | Definition of the measure. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qExpressions` | `array of string` | Array of expressions. |
| `qActiveExpression` | `integer` | Index to the active expression in a measure. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
---
### GetProperties
Shows the properties of an object.
Returns the identifier and the definition of the measure.
If the member delta is set to true in the request object, only the delta is retrieved.
The following is always returned in the output:
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProp` | [GenericMeasureProperties](#genericmeasureproperties) | |
Properties of `qProp`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeasure` | [NxLibraryMeasureDef](#nxlibrarymeasuredef) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeasure`
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | Label of the measure. |
| `qDef` | `string` | Definition of the measure. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qExpressions` | `array of string` | Array of expressions. |
| `qActiveExpression` | `integer` | Index to the active expression in a measure. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qExpressions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qNumFormat`
_Properties truncated due to depth limit._
**See also:**
- Set the properties of a bookmark
- Get the delta of properties
- Get the properties of an object
- Set the properties of an object
---
### Publish
**Access control:** `publish`
Publishes a measure.
This operation is not applicable for Qlik Sense Desktop.
**Returns:** `object`
**See also:**
- Publish a bookmark
- Publish an app to a stream
- Publish a dimension
- Publish a generic object
- Publish a measure
---
### SetProperties
**Access control:** `update`
Sets some properties for a measure.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericMeasureProperties](#genericmeasureproperties) | Yes | Information about the measure. |
**Returns:** `object`
**See also:**
- Set the properties of a bookmark
- Set the properties of an object
- [SetFullPropertyTree method](#setfullpropertytree)
---
### UnApprove
**Access control:** `approve`
Removes the generic measure from the list of approved objects
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### UnPublish
**Access control:** `publish`
Unpublishes a measure.
This operation is not applicable for Qlik Sense Desktop.
**Returns:** `object`
---
## GenericObject
### AbortListObjectSearch
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the list object. For example, _/qListObjectDef_ . |
**Returns:** `object`
**See also:**
- Abort the results of a search in a list object
- Accept the results of a search in a list object
- Search for a string in a list object
---
### AcceptListObjectSearch
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the list object. For example, _/qListObjectDef_ . |
| `qToggleMode` | `boolean` | Yes | Set to true to keep any selections present in the list object. If this parameter is set to false, selections made before accepting the list object search become alternative. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**See also:**
- Abort the results of a search in a list object
- Accept the results of a search in a list object
- Search for a string in a list object
---
### AddGroupMembers **[experimental]**
**Access control:** `update`
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For exampleb _/qNxGroupDef_ . |
| `qMembers` | `array` of [NxGroupObjectId](#nxgroupobjectid) | Yes | Array of IDs for the objects and/or subgroups to add to the group. |
| `qTargetGroupId` | `string` | No | Name of the group the Members will be added to (if not the called object). |
| `qPosId` | `string` | No | Id of the member whose position to insert into. |
**Returns:** `object`
---
### ApplyPatches
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPatches` | `array` of [NxPatch](#nxpatch) | Yes | Array of patches. |
| `qSoftPatch` | `boolean` | No | 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. |
**Returns:** `object`
**See also:**
- Add some properties to an object
- Remove some properties
- Update some properties of an object
---
### Approve
**Access control:** `approve`
Adds the generic object to the list of approved objects
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### BeginSelections
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPaths` | `array of string` | Yes | List of the paths to the definition of the objects to enter selection mode. For example, _/qListObjectDef_ . |
**Returns:** `object`
---
### ClearSelections
Clears the selections in a dimension of a visualization.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the visualization. For example, _/qListObjectDef_ . |
| `qColIndices` | `array of integer` | No | 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. |
**Returns:** `object`
**See also:**
- Clear the selections in a visualization
---
### 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_.
**Returns:** `object`
**See also:**
- Remove a soft patch or soft properties
---
### CollapseLeft
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be collapsed. For example, _/qHyperCubeDef_ . |
| `qRow` | `integer` | Yes | Row index in the data matrix. Indexing starts from 0. |
| `qCol` | `integer` | Yes | Column index. The index is based on the left dimension indexes. Indexing starts from 0. |
| `qAll` | `boolean` | Yes | 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). |
**Returns:** `object`
**See also:**
- Collapse or expand the left dimensions of a pivot table
---
### CollapseTop
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be collapsed For example, _/qHyperCubeDef_ . |
| `qRow` | `integer` | Yes | Row index. The index is based on the top dimension indexes. Indexing starts from 0. |
| `qCol` | `integer` | Yes | Column index in the data matrix. Indexing starts from 0. |
| `qAll` | `boolean` | Yes | 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). |
**Returns:** `object`
**See also:**
- Collapse or expand the top dimensions of a pivot table
---
### CopyFrom
**Access control:** `update`
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFromId` | `string` | Yes | Identifier of the object to copy. |
**Returns:** `object`
**See also:**
- Copy the properties and the children of a generic object
---
### CreateChild
**Access control:** `update`
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericObjectProperties](#genericobjectproperties) | Yes | Information about the child. It is possible to create a child that is linked to another object. |
| `qPropForThis` | [GenericObjectProperties](#genericobjectproperties) | No | 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. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
**See also:**
- Add a slide to a story
- Create a hypercube
- Create a list object
---
### CreateGroup **[experimental]**
**Access control:** `create`, `update`
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example _/qNxGroupDef_ . |
| `qGroupDef` | [NxGroupDef](#nxgroupdef) | Yes | Definition of the new group. |
| `qTargetGroupId` | `string` | No | Id of the group to create the new subgroup in (if not the called object). |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qGroupId` | `string` | |
---
### DestroyAllChildren
**Access control:** `update`
Removes all children and all children to the children on an object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPropForThis` | [GenericObjectProperties](#genericobjectproperties) | No | 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. |
**Returns:** `object`
---
### DestroyChild
**Access control:** `update`
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the child to remove. |
| `qPropForThis` | [GenericObjectProperties](#genericobjectproperties) | No | 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. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Remove a child object
---
### DrillUp
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qDimNo` | `integer` | Yes | Dimension number or index starting from 0. The default value is 0. |
| `qNbrSteps` | `integer` | Yes | Number of steps you want to drill up. The default value is 0. |
**Returns:** `object`
**See also:**
- Drill up a hierarchy
---
### EmbedSnapshotObject
**Access control:** `update`
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the bookmark. |
**Returns:** `object`
---
### EndSelections
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qAccept` | `boolean` | Yes | Set this parameter to true to accept the selections before exiting the selection mode. |
**Returns:** `object`
**See also:**
- Enter and exit the selection mode
- [AbortModal method](#abortmodal)
- [BeginSelections method](#beginselections)
---
### ExpandLeft
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be expanded. For example, _/qHyperCubeDef_ . |
| `qRow` | `integer` | Yes | Row index in the data matrix to expand. Indexing starts from 0. |
| `qCol` | `integer` | Yes | Column index. The index is based on the left dimension indexes. Indexing starts from 0. |
| `qAll` | `boolean` | Yes | 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). |
**Returns:** `object`
**See also:**
- Collapse or expand the left dimensions of a pivot table
---
### ExpandTop
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be expanded. For example, _/qHyperCubeDef_ . |
| `qRow` | `integer` | Yes | Row index. The index is based on the top dimension indexes. Indexing starts from 0. |
| `qCol` | `integer` | Yes | Column index in the data matrix. Indexing starts from 0. |
| `qAll` | `boolean` | Yes | 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). |
**Returns:** `object`
**See also:**
- Collapse or expand the top dimensions of a pivot table
---
### ExportData
**Access control:** `exportdata`
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**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qFileType` | `string` | Yes | Type of the file to export. One of: * CSV_C or EXPORT_CSV_C * CSV_T or EXPORT_CSV_T * OOXML or EXPORT_OOXML * PARQUET or EXPORT_PARQUET |
| `qPath` | `string` | No | Path to the definition of the object to be exported. For example, _/qHyperCubeDef_ . This parameter is mandatory if the file type is _CSV_C_ or _CSV_T_ . |
| `qFileName` | `string` | No | Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop. |
| `qExportState` | `string` | No | Defines the values to be exported. The default value is A. One of: * P or EXPORT_POSSIBLE * A or EXPORT_ALL |
| `qServeOnce` | `boolean` | No | If the exported file should be served only once This parameter is optional and only used in Qlik Sense Enterprise (Windows) Default value: false |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | |
| `qWarnings` | `array of integer` | |
Properties of `qWarnings`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
**See also:**
- Export the data of a generic object
---
### GetChild
Returns the type of the object and the corresponding handle.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qId` | `string` | Yes | Identifier of the object. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
**See also:**
- Get the handle of a child
---
### 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.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfos` | `array` of [NxInfo](#nxinfo) | |
Properties of `qInfos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxInfo` | [NxInfo](#nxinfo) | |
Properties of `NxInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
**See also:**
- List the children of a generic object
---
### 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.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProp` | [GenericObjectProperties](#genericobjectproperties) | |
Properties of `qProp`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qExtendsId` | `string` | Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string. |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
**See also:**
- Get the properties of an object
- [GetProperties method](#getproperties)
---
### GetFullPropertyTree
Gets the properties of:
* A generic object.
* The children of the generic object.
* The bookmarks/embedded snapshots of the generic object.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qPropEntry` | [GenericObjectEntry](#genericobjectentry) | |
Properties of `qPropEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qProperty` | [GenericObjectProperties](#genericobjectproperties) | |
| `qChildren` | `array` of [GenericObjectEntry](#genericobjectentry) | Information about the children of the generic object. |
| `qEmbeddedSnapshotRef` | [GenericBookmarkEntry](#genericbookmarkentry) | |
Properties of `qProperty`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qExtendsId` | `string` | Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string. |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qChildren`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericObjectEntry` | [GenericObjectEntry](#genericobjectentry) | |
Properties of `qEmbeddedSnapshotRef`
| Name | Type | Description |
| --- | --- | --- |
| `qProperties` | [GenericBookmarkProperties](#genericbookmarkproperties) | |
| `qBookmark` | [NxBookmark](#nxbookmark) | |
| `qClassicBookmark` | [Bookmark](#bookmark) | |
| `qClassicMetadata` | [MetaData](#metadata) | |
Properties of `qProperties`
_Properties truncated due to depth limit._
Properties of `qBookmark`
_Properties truncated due to depth limit._
Properties of `qClassicBookmark`
_Properties truncated due to depth limit._
Properties of `qClassicMetadata`
_Properties truncated due to depth limit._
**See also:**
- Set the properties of an object
---
### GetHyperCubeBinnedData
This method supports data binning.
When a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points.
A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the _qQueryLevel_ parameter) or coarsened (for zoom out).
The grid of cells is adaptive (not static), meaning that it adapts to different length scales.
The _GetHyperCubeBinnedData_ method gives information about the adaptive grid and the values of the generic object.
The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned.
Dimension values and measure values are rendered at point level (highest detailed level).
The generic object should contain two or three measures and one dimension. When the refinement is high, the first two measures are represented on the x-axis and on the y-axis, while the third measure is visualized as color or point size.
**Adaptive Grid**
More details about the properties of the adaptive grid are given in this paragraph.
When the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays.
The first array contains the following properties:
| Name |
Description |
Type |
| qNum |
Maximum number of points that a cell can contain. |
String |
| qElemNumber |
Is set to 0. |
Boolean |
| qState |
The default value is L. |
One of:
- L for Locked
- S for Selected
- O for Optional
- D for Deselected
- A for Alternative
- X for eXcluded
- XS for eXcluded Selected
- XL for eXcluded Locked
|
The next arrays give the coordinates of each cell in the page.
Each array contains the following properties:
| Name |
Description |
Type |
| qText |
Coordinates of a cell in the measure range.
“qText”: “[[<left>, <top>, <right>, <bottom>], [<left>, <top>, <right>, <bottom>], .... [<left>, <top>, <right>, <bottom>]]
Where:
< left >, < top >, < right > and < bottom > are the coordinates of the cell in the measure range. |
String |
| qNum |
Number of points in the cell. |
Double precision floating point |
| qElemNumber |
Unique identifier for each cell, calculated by the engine during the construction of the grid.
This element number is not stored in the database and can have a positive or a negative value. |
Integer |
| qState |
The default value is L. |
One of:
- L for Locked
- S for Selected
- O for Optional
- D for Deselected
- A for Alternative
- X for eXcluded
- XS for eXcluded Selected
- XL for eXcluded Locked
|
Cells are represented as rectangles.
**Dimension values and measures values**
More details about the properties, when dimension and measure values are returned, are given in this paragraph.
When the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned.
The first array is empty because no information on the adaptive grid is needed.
The next arrays bring information about the dimension and the measure values.
| Name |
Description |
Type |
| qText |
Text value of the dimension or the measure. |
String |
| qNum |
Numerical value of the dimension or the measure.
Is set to 0 if the value is only text. |
Double precision floating point |
| qElemNumber |
Unique identifier for each cell, calculated by the engine during the construction of the grid.
This element number is not stored in the database and can have a positive or a negative value. |
Integer |
| qState |
The default value is L. |
One of:
- L for Locked
- S for Selected
- O for Optional
- D for Deselected
- A for Alternative
- X for eXcluded
- XS for eXcluded Selected
- XL for eXcluded Locked
|
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object. For example, _/qHyperCubeDef_ . |
| `qPages` | `array` of [NxPage](#nxpage) | Yes | Array of pages to retrieve. Since the generic object contains two measures and one dimension, _qWidth_ should be set to 3. If the value of a measure is Null, the value cannot be rendered. Therefore, the number of elements rendered in a page can be less than the number defined in the property _qHeight_ . |
| `qViewport` | [NxViewPort](#nxviewport) | Yes | Defines the canvas and the zoom level. This parameter is not yet used and is optional. |
| `qDataRanges` | `array` of [NxDataAreaPage](#nxdataareapage) | Yes | Range of the data to render. This range applies to the measure values. The lowest and highest values of a measure can be retrieved by using the _GetLayout method_ (in _/qHyperCube/qMeasureInfo_ ). |
| `qMaxNbrCells` | `integer` | Yes | Maximum number of cells in the grid. |
| `qQueryLevel` | `integer` | Yes | Level of details. The higher the level, the more detailed information you get (zoom-in). When the number of points to render falls below a certain threshold, the values are no longer rendered as cells but as points. The query level should be no greater than 20. |
| `qBinningMethod` | `integer` | Yes | Selects the algorithm. The default value is 0. One of: * 0: Adaptive grid * 1: Hexagonal grid * 2: Uniform grid |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDataPages` | `array` of [NxDataPage](#nxdatapage) | |
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDataPage` | [NxDataPage](#nxdatapage) | |
Properties of `NxDataPage`
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxCellRows](#nxcellrows) | Array of data. |
| `qTails` | `array` of [NxGroupTail](#nxgrouptail) | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty _[ ]_ . |
| `qArea` | [Rect](#rect) | |
| `qIsReduced` | `boolean` | Is set to true, if the data have been reduced. The default value is false. |
Properties of `qMatrix`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTails`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
**See also:**
- Get the adaptive grid and the values of a generic object
---
### GetHyperCubeContinuousData
Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.
Binning is done on the time stamp data as well as the date. This means that you can zoom in to a level of granularity as low as seconds.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object. For example, _/qHyperCubeDef_ . |
| `qOptions` | [NxContinuousDataOptions](#nxcontinuousdataoptions) | Yes | Defines the data to return. |
| `qReverseSort` | `boolean` | No | If set to true the returned data pages are reverse sorted. Optional. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDataPages` | `array` of [NxDataPage](#nxdatapage) | |
| `qAxisData` | [NxAxisData](#nxaxisdata) | |
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDataPage` | [NxDataPage](#nxdatapage) | |
Properties of `NxDataPage`
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxCellRows](#nxcellrows) | Array of data. |
| `qTails` | `array` of [NxGroupTail](#nxgrouptail) | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty _[ ]_ . |
| `qArea` | [Rect](#rect) | |
| `qIsReduced` | `boolean` | Is set to true, if the data have been reduced. The default value is false. |
Properties of `qMatrix`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTails`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
Properties of `qAxisData`
| Name | Type | Description |
| --- | --- | --- |
| `qAxis` | `array` of [NxAxisTicks](#nxaxisticks) | List of axis data. |
Properties of `qAxis`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAxisTicks` | [NxAxisTicks](#nxaxisticks) | |
Properties of `NxAxisTicks`
_Properties truncated due to depth limit._
---
### GetHyperCubeData
Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.
This method works for a hypercube in DATA_MODE_STRAIGHT.
A data set is returned.
**Limitations on the number of cells**
The maximum for the combined total number of cells across all pages is:
* 10,000 cells. If this limit is exceeded, a calc-pages-too-large error with code 7009 is returned.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qPages` | `array` of [NxPage](#nxpage) | Yes | Array of pages to retrieve. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDataPages` | `array` of [NxDataPage](#nxdatapage) | |
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDataPage` | [NxDataPage](#nxdatapage) | |
Properties of `NxDataPage`
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxCellRows](#nxcellrows) | Array of data. |
| `qTails` | `array` of [NxGroupTail](#nxgrouptail) | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty _[ ]_ . |
| `qArea` | [Rect](#rect) | |
| `qIsReduced` | `boolean` | Is set to true, if the data have been reduced. The default value is false. |
Properties of `qMatrix`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTails`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
**See also:**
- Add attribute expressions to a measure
- Get the values of a chart, a table or a scatter plot
---
### GetHyperCubePivotData
Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.
This method works for a hypercube in DATA_MODE_PIVOT.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qPages` | `array` of [NxPage](#nxpage) | Yes | Array of pages to retrieve. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDataPages` | `array` of [NxPivotPage](#nxpivotpage) | |
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPivotPage` | [NxPivotPage](#nxpivotpage) | |
Properties of `NxPivotPage`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about the left dimension values of a pivot table. |
| `qTop` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given. |
| `qData` | `array` of [ArrayOfNxValuePoint](#arrayofnxvaluepoint) | Array of data. |
| `qArea` | [Rect](#rect) | |
Properties of `qLeft`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTop`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qData`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
**See also:**
- Get the values of a pivot table
- Sort by the values of a measure in a pivot table
---
### GetHyperCubeReducedData
Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.
The reduction is dependent on the zoom factor (parameter _qZoomFactor_ ) and on the reduction mode.
This method can be used to create mini charts.
**Bar chart or line chart data reduction**
For the data reduction to happen, the following conditions must be fulfilled:
* The values cannot fit in the defined page (parameter _qPages_ ).
* The zoom factor is not 0 (parameter _qZoomFactor_ ).
* The reduction mode must be set to D1.
The reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.
**Example**
If you have a chart with 1 million data, and you have set the zoom factor to 5, the _GetHyperCubeReducedData_ method reduces the chart and retrieves 200 000 data.
**Scatter plot chart data reduction**
The reduction mode must be set to C.
This reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid.
The number of centroids can be defined in the parameter _qZoomFactor_.
**Scatter plot chart resolution reduction**
The reduction mode must be set to S.
The resolution is reduced according to the zoom factor (parameter _qZoomFactor_ ).
**Example**
If you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qPages` | `array` of [NxPage](#nxpage) | Yes | Array of pages. |
| `qZoomFactor` | `integer` | Yes | Defines the zoom factor. If set to -1, the engine decides of the zoom factor. * If the reduction mode is _D1_ or _S_ , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32. * If the reduction mode is _C_ , the zoom factor defines the number of centroids. |
| `qReductionMode` | `string` | Yes | Defines the reduction mode. One of: * N or DATA_REDUCTION_NONE * D1 or DATA_REDUCTION_ONEDIM * S or DATA_REDUCTION_SCATTERED * C or DATA_REDUCTION_CLUSTERED * ST or DATA_REDUCTION_STACKED |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDataPages` | `array` of [NxDataPage](#nxdatapage) | |
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDataPage` | [NxDataPage](#nxdatapage) | |
Properties of `NxDataPage`
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxCellRows](#nxcellrows) | Array of data. |
| `qTails` | `array` of [NxGroupTail](#nxgrouptail) | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty _[ ]_ . |
| `qArea` | [Rect](#rect) | |
| `qIsReduced` | `boolean` | Is set to true, if the data have been reduced. The default value is false. |
Properties of `qMatrix`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTails`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
**See also:**
- Reduce the values of a chart
---
### GetHyperCubeStackData
Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.
This method works for a hypercube in DATA_MODE_PIVOT_STACK.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qPages` | `array` of [NxPage](#nxpage) | Yes | Array of pages to retrieve. |
| `qMaxNbrCells` | `integer` | No | Maximum number of cells at outer level. The default value is 10 000. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDataPages` | `array` of [NxStackPage](#nxstackpage) | |
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxStackPage` | [NxStackPage](#nxstackpage) | |
Properties of `NxStackPage`
| Name | Type | Description |
| --- | --- | --- |
| `qData` | `array` of [NxStackedPivotCell](#nxstackedpivotcell) | Array of data. |
| `qArea` | [Rect](#rect) | |
Properties of `qData`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
**See also:**
- Get the values of a stacked table
- Sort by the values of a measure in a stacked pivot table
---
### GetHyperCubeTreeData
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.
This method works for a treedata object or a hypercube in DATA_MODE_TREE.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. |
| `qNodeOptions` | [NxTreeDataOption](#nxtreedataoption) | No | Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qNodes` | `array` of [NxTreeNode](#nxtreenode) | |
Properties of `qNodes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTreeNode` | [NxTreeNode](#nxtreenode) | Represents a dimension in the tree. |
Properties of `NxTreeNode`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | The text version of the value, if available. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qElemNo` | `integer` | Element number. |
| `qGroupPos` | `integer` | The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched. |
| `qGroupSize` | `integer` | Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched. |
| `qRow` | `integer` | Row index in the data matrix. The indexing starts from 0. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qValues` | `array` of [NxTreeValue](#nxtreevalue) | The measures for this node. |
| `qNodes` | `array` of [NxTreeNode](#nxtreenode) | The children of this node in the fetched tree structure. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
| `qMaxPos` | `array of number` | Total of the positive values in the current group of cells. |
| `qMinNeg` | `array of number` | Total of the negative values in the current group of cells. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qState` | oneOf(L \| S \| O \| D \| A \| X \| XS \| XL \| NSTATES) | |
| `qTreePath` | `array of integer` | The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty. |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qMaxPos`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMinNeg`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qState`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
Properties of `qTreePath`
**Array items:**
_Properties truncated due to depth limit._
---
### GetInfo
Returns the type and identifier of the object.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### GetLayout
Evaluates an object and displays its properties including the dynamic properties.
If the member _delta_ is set to true in the request object, only the delta is evaluated. A _GetLayout_ call on a generic object, returns up to one level down in the hierarchy.
**Example:**
_A_ is a generic object and is the parent of the objects B and C. _B_ is the parent of the objects D and E.
A _GetLayout_ call on A returns information on the objects A, B and C.
A _GetLayout_ call on B returns information on the objects B, D and E.
A _GetLayout_ call on C returns information on the object C.
In addition to the parameters displayed above, the **GetLayout** method can return other properties according to what is defined in the generic object.
For example, if **qHyperCubeDef** is defined in the generic object, the **GetLayout** method returns the properties described in _HyperCube_.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qLayout` | [GenericObjectLayout](#genericobjectlayout) | Is the layout for _GenericObjectProperties_. |
Properties of `qLayout`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qExtendsId` | `string` | Should be set to create an object that is linked to another object. Enter the identifier of the object you want to link to. If you do not want to link your object, set this parameter to an empty string. |
| `qHasSoftPatches` | `boolean` | Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied). |
| `qError` | [NxLayoutErrors](#nxlayouterrors) | |
| `qSelectionInfo` | [NxSelectionInfo](#nxselectioninfo) | |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. |
Properties of `qSelectionInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qInSelections` | `boolean` | Is set to true if the visualization is in selection mode. For more information about the selection mode, see _BeginSelections Method_. |
| `qMadeSelections` | `boolean` | Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see _BeginSelections Method_. |
**See also:**
- Get the layout of a bookmark
- List the dimensions in an app
- List the fields in an app
- List the measures in an app
- Get the delta of the layout
- Get the layout of a generic object
---
### GetLinkedObjects
Lists the linked objects to a generic object, a dimension or a measure.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxLinkedObjectInfo](#nxlinkedobjectinfo) | |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxLinkedObjectInfo` | [NxLinkedObjectInfo](#nxlinkedobjectinfo) | |
Properties of `NxLinkedObjectInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qRootId` | `string` | Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object. |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
_Properties truncated due to depth limit._
**See also:**
- List the linked objects of a generic object
---
### GetListObjectData
Retrieves the values of a list object.
A data set is returned.
**Limitations on the number of cells**
The maximum for the combined total number of cells across all pages is:
* 10,000 cells. If this limit is exceeded, a calc-pages-too-large error with code 7009 is returned.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qListObjectDef_ . |
| `qPages` | `array` of [NxPage](#nxpage) | Yes | Array of pages you are interested in. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDataPages` | `array` of [NxDataPage](#nxdatapage) | |
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDataPage` | [NxDataPage](#nxdatapage) | |
Properties of `NxDataPage`
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxCellRows](#nxcellrows) | Array of data. |
| `qTails` | `array` of [NxGroupTail](#nxgrouptail) | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty _[ ]_ . |
| `qArea` | [Rect](#rect) | |
| `qIsReduced` | `boolean` | Is set to true, if the data have been reduced. The default value is false. |
Properties of `qMatrix`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTails`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
**See also:**
- Get the values of a list object
---
### GetParent
Returns the type of the object and the corresponding handle to the parent object in the hiearchy.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### GetProperties
Returns the identifier, the type and the properties of the object.
Because it is not mandatory to set all properties when you define an object, the _GetProperties_ method may show properties that were not set. In that case, default values are given.
If the object contains some soft properties, the soft properties are not returned by the _GetProperties_ method. Use the _GetEffectiveProperties method_ instead.
If the object is linked to another object, the properties of the linking object are not returned by the _GetProperties_ method. Use the _GetEffectiveProperties method_ instead.
The properties depends on the generic object type, see [properties](genericobject-layout.html).
If the member delta is set to true in the request object, only the delta is retrieved.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProp` | [GenericObjectProperties](#genericobjectproperties) | |
Properties of `qProp`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qExtendsId` | `string` | Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string. |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
**See also:**
- Set the properties of a bookmark
- Get the delta of properties
- Get the properties of an object
- Set the properties of an object
---
### GetSnapshotObject
Returns the type of the object and the corresponding handle.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### Lock
Locks the selected values of a generic object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object. For example, _/qListObjectDef_ . |
| `qColIndices` | `array of integer` | No | Dimension numbers or dimension indexes where the lock should apply. Dimension numbers/indexes start from 0. If this parameter is not set, the selected values in all dimensions are locked. |
**Returns:** `object`
---
### MultiRangeSelectHyperCubeValues
Makes multiple range selections in measures.
This method applies to hypercubes. For example, bar charts, tables and scatter plots.
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains some invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qRanges` | `array` of [NxMultiRangeSelectInfo](#nxmultirangeselectinfo) | Yes | Ranges of selections. |
| `qOrMode` | `boolean` | No | Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false. |
| `qDeselectOnlyOneSelected` | `boolean` | No | Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### MultiRangeSelectTreeDataValues
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | |
| `qRanges` | `array` of [NxTreeMultiRangeSelectInfo](#nxtreemultirangeselectinfo) | Yes | |
| `qOrMode` | `boolean` | No | |
| `qDeselectOnlyOneSelected` | `boolean` | No | |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### Publish
**Access control:** `publish`
Publishes a generic object.
This operation is not applicable for Qlik Sense Desktop.
**Returns:** `object`
**See also:**
- Publish a bookmark
- Publish an app to a stream
- Publish a dimension
- Publish a generic object
- Publish a measure
---
### RangeSelectHyperCubeValues
Makes range selections in measures.
This method applies to hypercubes. For example, bar charts, tables and scatter plots.
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains some invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qRanges` | `array` of [NxRangeSelectInfo](#nxrangeselectinfo) | Yes | Ranges of selections. |
| `qColumnsToSelect` | `array of integer` | No | Indicates which dimensions to select. The dimensions numbering starts at 0 (first dimension is 0). If the array is empty, all dimensions are selected. |
| `qOrMode` | `boolean` | No | Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false. |
| `qDeselectOnlyOneSelected` | `boolean` | No | Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Select a range of values in a hypercube
- Select a range of values in a hypercube
---
### RemoveGroup **[experimental]**
**Access control:** `update`, `delete`
You can use the RemoveGroup method with any object that contains an object grouping definition.
This method allows you to remove a group of objects directly.
This action only removes the group, not any of its members.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example _/qNxGroupDef_ . |
| `qGroupId` | `string` | Yes | Name of the group to be removed. May not be an empty string. |
**Returns:** `object`
---
### RemoveGroupMembers **[experimental]**
**Access control:** `update`
You can use the RemoveGroupMembers method with any object that contains an object grouping definition.
This method allows you to remove one or more members from an existing group of objects directly.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example _/qNxGroupDef_ . |
| `qMembers` | `array of string` | Yes | Array of IDs for the objects and/or subgroups to remove from the group. |
| `qTargetGroupId` | `string` | No | Name of the group the Members will be removed from (if not the called object). |
**Returns:** `object`
---
### ResetMadeSelections
Resets all selections made in selection mode.
**Returns:** `object`
---
### SearchListObjectFor
Searches for a string in a list object.
This method applies to list objects (objects with one dimension).
The search results can be displayed using the _GetLayout Method_.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the list object. For example, _/qListObjectDef_ . |
| `qMatch` | `string` | Yes | Search string. Wild card characters are allowed. The search is not case sensitive. Examples: * `P*U*`: retrieves only values that start with P and contain U * `P U S`: retrieves values that start with P, U or S |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Abort the results of a search in a list object
- Accept the results of a search in a list object
- Search for a string in a list object
---
### SelectHyperCubeCells
Makes selections in multiple dimensions and measures.
This method applies to hypercubes, such as bar charts, tables and scatter plots.
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains some invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qRowIndices` | `array of integer` | Yes | Array of row indexes to select, starting from 0. If the array is empty _[ ]_ , all rows are selected. |
| `qColIndices` | `array of integer` | Yes | Indexes of the columns to select, starting from 0. A column corresponds to a dimension in the order they are added to the hypercube. If a column is hidden it is ignored, qColIndex n refers to the n:th visible column (starting from zero). Example: If the hypercube has two dimensions: * [0] selects the first column (i.e the first dimension). * [1] selects the second column (i.e the second dimension). If the array is empty _[ ]_ , all columns are selected. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. |
| `qDeselectOnlyOneSelected` | `boolean` | No | Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Select a set of cells in a hypercube
---
### SelectHyperCubeContinuousRange
The following is returned in the output:
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object. For example, _/qHyperCubeDef_ . |
| `qRanges` | `array` of [NxContinuousRangeSelectInfo](#nxcontinuousrangeselectinfo) | Yes | Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals. If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to _true_ then _Min_ and _Max_ values will be selected. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### SelectHyperCubeValues
Selects some values in one dimension.
The values are identified by their element numbers.
This method applies to charts, tables and scatter plots.
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains some invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qDimNo` | `integer` | Yes | Dimension number or index to select. Dimension numbers/index start from 0. |
| `qValues` | `array of integer` | Yes | Element numbers of the field to select. You can select multiple elements; the separator is the comma. |
| `qToggleMode` | `boolean` | Yes | Set to true to toggle. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Drill up a hierarchy
---
### SelectListObjectAll
Selects all values of a field.
This method applies to list objects (objects with one dimension).
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains some invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qListObjectDef_ . |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Select all values of a field
---
### SelectListObjectAlternative
Selects all alternative values in a specific field.
This method applies to list objects (objects with one dimension).
If a field contains at least one selected value, the values that are neither selected nor excluded are alternatives values.
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains some invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qListObjectDef_ . |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Select all alternative values of a field
---
### SelectListObjectContinuousRange
The following is returned in the output:
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object. For example, _/qHyperCubeDef_ . |
| `qRanges` | `array` of [Range](#range) | Yes | Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals. If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to _true_ then _Min_ and _Max_ values will be selected. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### SelectListObjectExcluded
Inverts the current selections in a specific field.
This method applies to list objects (objects with one dimension).
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains some invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qListObjectDef_ . |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Select all excluded values of a list object
---
### SelectListObjectPossible
Selects all possible values of a list object.
This method applies to list objects (objects with one dimension).
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qListObjectDef_ . |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Select all possible values of a list object
---
### SelectListObjectValues
Makes single selections in dimensions.
This method applies to list objects only.
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qListObjectDef_ . |
| `qValues` | `array of integer` | Yes | Element numbers to select. You can select multiple values; the separator is the comma. |
| `qToggleMode` | `boolean` | Yes | Set to true to toggle. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Select values in a list object
---
### SelectPivotCells
This method only applies to hypercubes that are not represented as straight tables. The parameter _qMode_ in _HyperCubeDef_ must be set either to _P_ or _K_ .
**Pivot table**
Makes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.
**Stacked table**
Makes selections in the left dimension cells of a stacked table or in the data matrix.
There is no top dimensions in a stacked table. A stacked table can only contain one measure.
The member **Change** returns the handles of the objects that are updated following the selections.
_qSuccess_ is set to _true_ if the selections are successful and is set to _false_ in the following cases:
* The object contains some invalid fields (fields that are not in the data model).
* The selection applies to a locked field.
* A range selection is performed and the parameter _OneAndOnlyOne_ is set to true in the definition of the object.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object. For example, _/qHyperCubeDef_ . |
| `qSelections` | `array` of [NxSelectionCell](#nxselectioncell) | Yes | Information about the selections to perform. |
| `qSoftLock` | `boolean` | No | Set to true to ignore locks; in that case, locked fields can be selected. |
| `qDeselectOnlyOneSelected` | `boolean` | No | Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Select dimension cells in a pivot table
- Select dimension cells in a stacked table
- Select values in a pivot table
---
### SetActiveField **[experimental]**
You can use the SetActiveField method with any object that contains a cyclic group as a dimension.
This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken.
A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qDimNo` | `integer` | Yes | Dimension number or index starting from 0. The default value is 0. |
| `qNewIndex` | `integer` | Yes | Index of the field to jump to. |
**Returns:** `object`
---
### SetChildArrayOrder
**Access control:** `update`
Sets the order of the children in a generic object.
To change the order of the children in a generic object, the identifiers of all the children must be included in the list of the identifiers (in _qIds_ ).
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qIds` | `array of string` | Yes | List of the children identifiers. |
**Returns:** `object`
**See also:**
- Set the order of the children in a generic object
---
### SetFullPropertyTree
**Access control:** `update`
Sets the properties of:
* A generic object.
* The children of the generic object.
* The bookmarks/embedded snapshots of the generic object.
If the _SetFullPropertyTree method_ is asked to set some properties to a child that does not exist, it creates the child.
The type of an object cannot be updated.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPropEntry` | [GenericObjectEntry](#genericobjectentry) | Yes | Information about the generic object entry. |
**Returns:** `object`
**See also:**
- Set the properties of an object
---
### SetGroupLabel **[experimental]**
**Access control:** `update`
You can use the SetGroupLabel method with any object that contains an object grouping definition.
This method allows you to change the label of an existing group of objects directly.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example _/qNxGroupDef_ . |
| `qNewLabel` | `string` | Yes | New label for the group. A label starting with an '=' will be evaluated as an expression. |
| `qTargetGroupId` | `string` | No | Id of the group whose label will be set (if not the called object). |
**Returns:** `object`
---
### SetProperties
**Access control:** `update`
Sets some properties for a generic object.
The properties depends on the generic object type, see [properties](genericobject-property.html).
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericObjectProperties](#genericobjectproperties) | Yes | Information about the generic object. |
**Returns:** `object`
**See also:**
- Set the properties of a bookmark
- Set the properties of an object
- [SetFullPropertyTree method](#setfullpropertytree)
---
### StepCycle **[experimental]**
You can use the StepCycle method with any object that contains a cyclic group as a dimension.
This method allows you to move between different fields in a cyclic dimension.
A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object to be selected. For example, _/qHyperCubeDef_ . |
| `qDimNo` | `integer` | Yes | Dimension number or index starting from 0. The default value is 0. |
| `qNbrSteps` | `integer` | Yes | Number of steps you want to cycle. Positive values cycle forwards while negative values cycle backwards. A value of 0 leads to no action being taken. |
**Returns:** `object`
---
### UnApprove
**Access control:** `approve`
Removes the generic object from the list of approved objects
This operation is possible only in Qlik Sense Enterprise.
**Returns:** `object`
---
### UnPublish
**Access control:** `publish`
Unpublishes a generic object.
This operation is not applicable for Qlik Sense Desktop.
**Returns:** `object`
---
### Unlock
Unlocks the selected values of a generic object if the target (or handle ) is a generic object
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Path to the definition of the object. For example, _/qListObjectDef_ . |
| `qColIndices` | `array of integer` | No | Dimension numbers/indexes where the unlock should apply. Dimension numbers/indexes start from 0. If this parameter is not set, the locked values in all dimensions are unlocked. |
**Returns:** `object`
---
## GenericVariable
### ApplyPatches
**Access control:** `update`
Applies a patch to the properties of a variable. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",
and it will be forbidden in the near future.
Applying a patch takes less time than resetting all the properties.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPatches` | `array` of [NxPatch](#nxpatch) | Yes | Array of patches. |
**Returns:** `object`
**See also:**
- Update the properties of a variable
---
### GetInfo
Returns the type and identifier of the object.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
**See also:**
- Get the identifier of a variable
---
### GetLayout
Evaluates an object and displays its properties including the dynamic properties.
If the member _delta_ is set to true in the request object, only the delta is evaluated.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qLayout` | [GenericVariableLayout](#genericvariablelayout) | Is the layout for _GenericVariableProperties_. |
Properties of `qLayout`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qText` | `string` | Some text. |
| `qNum` | `number` | A value. |
| `qIsScriptCreated` | `boolean` | If set to true, it means that the variable was defined via script. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
**See also:**
- Get the layout of a variable
---
### GetProperties
Shows the properties of an object.
If the member **delta** is set to true in the request, only the delta is retrieved.
The following is always returned in the output:
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProp` | [GenericVariableProperties](#genericvariableproperties) | |
Properties of `qProp`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qName` | `string` | Name of the variable. The name must be unique. This parameter is mandatory. |
| `qComment` | `string` | Comment related to the variable. This parameter is optional. |
| `qNumberPresentation` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIncludeInBookmark` | `boolean` | Set this property to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark. The value of a variable can affect the state of the selections. Script variables cannot be persisted in the bookmark. The default value is false. |
| `qDefinition` | `string` | Definition of the variable. |
| `qConstraints` | [GenericVariableConstraints](#genericvariableconstraints) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qNumberPresentation`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qConstraints`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(any \| number \| text) | |
| `qValuesText` | `array of string` | |
| `qValuesNum` | `array of number` | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qValuesText`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qValuesNum`
**Array items:**
_Properties truncated due to depth limit._
**See also:**
- Get the properties of a variable
---
### GetRawContent
Returns the raw value of a variable.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
---
### SetDualValue
Sets the value of a dual variable.
These changes are not persistent. They only last the duration of the engine session.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qText` | `string` | Yes | String representation of a dual value. Set this parameter to "", if the string representation is to be Null. |
| `qNum` | `number` | Yes | Numeric representation of a dual value. |
**Returns:** `object`
---
### SetNumValue
Sets a numerical value to a variable.
These changes are not persistent. They only last the duration of the engine session.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qVal` | `number` | Yes | Value of the variable. |
**Returns:** `object`
**See also:**
- Update the properties of a variable
---
### SetProperties
**Access control:** `update`
Sets some properties for a variable.
The identifier of a variable cannot be modified.
You cannot update the properties of a script-defined variable using the _SetProperties method_.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProp` | [GenericVariableProperties](#genericvariableproperties) | Yes | Information about the variable. |
**Returns:** `object`
**See also:**
- Update the properties of a variable
---
### SetStringValue
Sets a string value to a variable.
These changes are not persistent. They only last the duration of the engine session.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qVal` | `string` | Yes | Value of the variable. The string can contain an expression. |
**Returns:** `object`
**See also:**
- Update the properties of a variable
---
## Global
### AbortAll
Sets an abort flag on all pending and ongoing requests in the current engine session.
* If an abort flag is set on a pending request, the request is aborted.
* If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
**Returns:** `object`
---
### AbortRequest
Sets an abort flag on a specific request in the current engine session.
* If an abort flag is set on a pending request, the request is aborted.
* If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qRequestId` | `integer` | Yes | Identifier of request to abort. |
**Returns:** `object`
---
### AllowCreateApp
Indicates whether or not a user is able to create an app.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### CancelReload
**Access control:** `reload`
Cancels an ongoing reload. The reload of the app is stopped. The indexation can be canceled and _true_ is still the return value of the reload task.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qReason` | `string` | No | Reason for why the reload was cancelled. This will be echoed back to the user in the script log. |
**Returns:** `object`
**See also:**
- Cancel the reload of an app
---
### CancelRequest
Cancels an ongoing request. The request is stopped.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qRequestId` | `integer` | Yes | Identifier of the request to stop. |
**Returns:** `object`
**See also:**
- Cancel a request
---
### ConfigureReload
**Access control:** `reload`
Configures the engine's behavior during a reload.
The _ConfigureReload method_ should be run before the _DoReload method_.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qCancelOnScriptError` | `boolean` | Yes | If set to true, the script execution is halted on error. Otherwise, the engine continues the script execution. This parameter is relevant only if the variable _ErrorMode_ is set to 1. |
| `qUseErrorData` | `boolean` | Yes | If set to true, any script execution error is returned in _qErrorData_ by the _GetProgress method_. |
| `qInteractOnError` | `boolean` | Yes | If set to true, the script execution is halted on error and the engine is waiting for an interaction to be performed. If the result from the interaction is 1 (_qDef.qResult_ is 1), the engine continues the script execution otherwise the execution is halted. This parameter is relevant only if the variable _ErrorMode_ is set to 1 and the script is run in debug mode (_qDebug_ is set to true when calling the _DoReload method_). |
**Returns:** `object`
**See also:**
- Configure the reload of a script
---
### CopyApp
**Access control:** `duplicate`
Copies an app that is in the Qlik Sense repository.
The engine copies the app into an app entity that was previously created by the repository.
This operation is possible only in Qlik Sense Enterprise.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qTargetAppId` | `string` | Yes | Identifier (GUID) of the app entity in the Qlik Sense repository. The app entity must have been previously created by the Qlik Sense Repository Service (QRS) API. |
| `qSrcAppId` | `string` | Yes | Identifier (GUID) of the source app in the Qlik Sense repository. |
| `qIds` | `array of string` | Yes | Array of QRS identifiers. The list of all objects in the app to be copied must be given. This list must contain the GUIDs of all these objects. If the list of the QRS identifiers is empty, the _CopyApp_ method copies all objects to the target app. Script-defined variables are automatically copied when copying an app. To be able to copy variables not created via script, the GUID of each variable must be provided in the list of QRS identifiers. To get the QRS identifiers of the objects in an app, you can use the QRS API. The GET method (from the QRS API) returns the identifiers of the objects in the app. The following example returns the QRS identifiers of all the objects in a specified app: GET /qrs/app/9c3f8634-6191-4a34-a114-a39102058d13 Where _9c3f8634-6191-4a34-a114-a39102058d13_ is the identifier of the app. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Copy an app
- See the Qlik Sense Repository Service API for more information
---
### CreateApp
**Access control:** `create`
Creates an app.
The operation is successful if **qSuccess** is set to true.
**Logs**
When this method is called, audit activity logs are produced to track the user activity.
In the case of errors, both audit activity logs and system services logs are produced.
The log files are named as follows:
| Audit activity log |
System service log |
<MachineName>_AuditActivity_Engine.txt in Qlik Sense Enterprise
<MachineName>_AuditActivity_Engine.log in Qlik Sense Desktop |
<MachineName>_ServiceEngine.txt in Qlik Sense Enterprise
<MachineName>_ServiceEngine.log in Qlik Sense Desktop |
**Where to find the log files**
The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.
| Qlik Sense Enterprise |
Qlik Sense Desktop |
| %ProgramData%/Qlik/Sense/Log/Engine |
%UserProfile%/Documents/Qlik/Sense/Log |
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qAppName` | `string` | Yes | Name of the app. |
| `qLocalizedScriptMainSection` | `string` | No | Name of the first section in the script editor. The default value is _Main_. |
| `qLocale` | `string` | No | Set custom locale for the app instead of system default. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
| `qAppId` | `string` | |
**See also:**
- Create an app
---
### CreateDocEx
**Access control:** `create`
Creates an app and opens an engine session.
This operation is possible only in Qlik Sense Desktop.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qDocName` | `string` | Yes | Name of the app. |
| `qUserName` | `string` | No | Name of the user. |
| `qPassword` | `string` | No | Password of the user. |
| `qSerial` | `string` | No | Current Qlik Sense serial number. |
| `qLocalizedScriptMainSection` | `string` | No | Name of the first section in the script editor. The default value is _Main_. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDocId` | `string` | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
**See also:**
- Create and open an app
---
### CreateSessionApp
**Access control:** `create`
Creates an empty session app.
The following applies:
* The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app.
* A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSessionAppId` | `string` | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
**See also:**
- Create an app
- [CreateSessionAppFromApp method](#createsessionappfromapp)
---
### CreateSessionAppFromApp
**Access control:** `create`
Creates a session app from a source app.
The following applies:
* The objects in the source app are copied into the session app.
* There is no data in the session app, unless it is reloaded.
* The script of the session app can be edited and reloaded.
* The name of a session app cannot be chosen. The engine automatically assigns a unique identifier to the session app.
* A session app is not persisted and cannot be saved. Everything created during a session app is non-persisted; for example: objects, data connections.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qSrcAppId` | `string` | Yes | App identifier of the source app. It corresponds to _qAppId_ returned by the _CreateApp method_ when creating the source app. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSessionAppId` | `string` | |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
**See also:**
- Create an app
- [CreateSessionApp method](#createsessionapp)
---
### DeleteApp
**Access control:** `delete`
Deletes an app from the Qlik Sense repository or from the file system.
**Qlik Sense Enterprise**
In addition to being removed from the repository, the app is removed from the directory as well:
*<installation_directory>\Qlik\Sense\Apps*
The default installation directory is _ProgramData_.
**Qlik Sense Desktop**
The app is deleted from the directory _%userprofile%\Documents\Qlik\ \Apps_.
The operation is successful if **qSuccess** is set to true.
**Logs**
When this method is called, audit activity logs are produced to track the user activity.
In the case of errors, both audit activity logs and system services logs are produced.
The log files are named as follows:
| Audit activity log |
System service log |
| <MachineName>AuditActivityEngine.txt in Qlik Sense Enterprise <MachineName>AuditActivityEngine.log in Qlik Sense Desktop |
<MachineName>ServiceEngine.txt in Qlik Sense Enterprise <MachineName>ServiceEngine.log in Qlik Sense Desktop |
**Where to find the log files**
The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.
| Qlik Sense Enterprise |
Qlik Sense Desktop |
| %ProgramData%/Qlik/Sense/Log/Engine |
%UserProfile%/Documents/Qlik/Sense/Log |
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qAppId` | `string` | Yes | Identifier of the app to delete. In Qlik Sense Enterprise, the identifier of the app is a GUID in the Qlik Sense repository. In Qlik Sense Desktop, the identifier of the app is the name of the app, as defined in the apps folder _%userprofile%\Documents\Qlik\Sense\Apps_. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Delete an app
---
### EngineVersion
Returns the version number of the Qlik engine component.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qVersion` | [NxEngineVersion](#nxengineversion) | |
Properties of `qVersion`
| Name | Type | Description |
| --- | --- | --- |
| `qComponentVersion` | `string` | Version number of the Qlik engine component. |
---
### ExportApp
Exports an app from the Qlik Sense repository to the file system.
This operation is possible only in Qlik Sense Enterprise.
The operation is successful if **qSuccess** is set to true.
**Logs**
When this method is called, audit activity logs are produced to track the user activity.
In the case of errors, both audit activity logs and system services logs are produced.
The log files are named as follows:
| Audit activity log |
System service log |
| *<MachineName>_AuditActivityEngine.txt* |
*<MachineName>_ServiceEngine.txt* |
The log files are located in:
_%ProgramData%/Qlik/Sense/Log/Engine_
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qTargetPath` | `string` | Yes | Path and name of the target app. |
| `qSrcAppId` | `string` | Yes | Identifier of the source app. The identifier is a GUID from the Qlik Sense repository. |
| `qIds` | `array of string` | Yes | Array of identifiers. The list of all the objects in the app to be exported must be given. This list must contain the GUIDs of all these objects. |
| `qNoData` | `boolean` | No | Set this parameter to true if the data should be omitted in the exported app. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
**See also:**
- Export an app
---
### GetActiveDoc
Returns the handle of the current app.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
**See also:**
- Create and open an app
---
### GetAppEntry
Retrieves the meta data of an app.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qAppID` | `string` | Yes | Identifier of the app, as returned by the _CreateApp method_. One of: * Path and name of the app (Qlik Sense Desktop) * GUID (Qlik Sense Enterprise) |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qEntry` | [AppEntry](#appentry) | |
Properties of `qEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qID` | `string` | Identifier of the app. |
| `qTitle` | `string` | Title of the app. |
| `qPath` | `string` | Path of the app. |
| `qLastReloadTime` | `string` | Last reload time of the app. |
| `qReadOnly` | `boolean` | Is set to true if the app is read-only. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qThumbnail` | [StaticContentUrl](#staticcontenturl) | In addition, this structure can return dynamic properties.
|
| `qFileSize` | `integer` | |
| `qHasSectionAccess` | `boolean` | If true the app has section access configured. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qThumbnail`
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
---
### GetAuthenticatedUser
Retrieves information about the authenticated user.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
**See also:**
- Get information about the authenticated user
---
### GetBNF _(deprecated)_
> **Deprecated:** Use the _GetBaseBNF_ method instead
Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. The BNF rules define the syntax for the script statements and the script or chart functions.
In the Qlik engine BNF grammar, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qBnfType` | `string` | Yes | Returns a set of rules defining the syntax for: * The script statements and the script functions if _qBnfType_ is set to S. * The chart functions if _qBnfType_ is set to E. One of: * S or SCRIPT_TEXT_SCRIPT * E or SCRIPT_TEXT_EXPRESSION |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qBnfDefs` | `array` of [BNFDef](#bnfdef) | |
Properties of `qBnfDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BNFDef` | [BNFDef](#bnfdef) | |
Properties of `BNFDef`
| Name | Type | Description |
| --- | --- | --- |
| `qBnf` | `array of integer` | Array of token references that all together build up the definition of the current token. Generally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF rules do have an empty array (_qIsBnfRule_ is set to true, but _qBnf_ is empty). |
| `qNbr` | `integer` | Number of the current token definition. |
| `qPNbr` | `integer` | Number of the parent rule definition. |
| `qHelpId` | `integer` | Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name. Is not used in Qlik Sense. |
| `qName` | `string` | Token name. One of: * A rule name * An identifier * A literal value |
| `qStr` | `string` | Literal string of the token. Examples: 'Round' and '('. |
| `qIsBnfRule` | `boolean` | If set to true, a list of related rule tokens is assigned to _qBnf_ . This parameter is optional. The default value is false. |
| `qScriptStatement` | `boolean` | If set to true, the definition specifies a script statement. This parameter is optional. The default value is false. |
| `qControlStatement` | `boolean` | If set to true, the definition specifies a control statement. This parameter is optional. The default value is false. |
| `qBnfLiteral` | `boolean` | If set to true, the definition specifies a literal token. This parameter is optional. The default value is false. |
| `qQvFunc` | `boolean` | If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function. This parameter is optional. The default value is false. |
| `qAggrFunc` | `boolean` | If set to true, the definition is related to an aggregation function. This parameter is optional. The default value is false. |
| `qFG` | oneOf(ALL \| U \| NONE \| AGGR \| NUM \| RNG \| EXP \| TRIG \| FIN \| MATH \| COUNT \| STR \| MAPP \| RCRD \| CND \| LOG \| NULL \| SYS \| FILE \| TBL \| DATE \| NUMI \| FRMT \| CLR \| RNK \| GEO \| EXT \| PROB \| ARRAY \| LEG \| DB \| WINDOW) | |
| `qFieldFlag` | `boolean` | If set to true, the definition is related to a field. This parameter is optional. The default value is false. |
| `qMT` | oneOf(N \| D \| R \| V) | |
| `qDepr` | `boolean` | Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use). If set to true, the script statement or the function is not recommended for use in Qlik Sense. This parameter is optional. The default value is false. |
| `qFGList` | `array` of [FunctionGroup](#functiongroup) | List of groups the function belongs to. |
Properties of `qBnf`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qFG`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
**Option 11:**
_Properties truncated due to depth limit._
**Option 12:**
_Properties truncated due to depth limit._
**Option 13:**
_Properties truncated due to depth limit._
**Option 14:**
_Properties truncated due to depth limit._
**Option 15:**
_Properties truncated due to depth limit._
**Option 16:**
_Properties truncated due to depth limit._
**Option 17:**
_Properties truncated due to depth limit._
**Option 18:**
_Properties truncated due to depth limit._
**Option 19:**
_Properties truncated due to depth limit._
**Option 20:**
_Properties truncated due to depth limit._
**Option 21:**
_Properties truncated due to depth limit._
**Option 22:**
_Properties truncated due to depth limit._
**Option 23:**
_Properties truncated due to depth limit._
**Option 24:**
_Properties truncated due to depth limit._
**Option 25:**
_Properties truncated due to depth limit._
**Option 26:**
_Properties truncated due to depth limit._
**Option 27:**
_Properties truncated due to depth limit._
**Option 28:**
_Properties truncated due to depth limit._
**Option 29:**
_Properties truncated due to depth limit._
**Option 30:**
_Properties truncated due to depth limit._
**Option 31:**
_Properties truncated due to depth limit._
**Option 32:**
_Properties truncated due to depth limit._
Properties of `qMT`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
Properties of `qFGList`
**Array items:**
_Properties truncated due to depth limit._
**See also:**
- Get the Qlik Sense script syntax grammar
---
### GetBaseBNF
Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed.
In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qBnfType` | `string` | Yes | The type of grammar to return: * The script statements and the script functions if _qBnfType_ is set to S. * The chart functions if _qBnfType_ is set to E. One of: * S or SCRIPT_TEXT_SCRIPT * E or SCRIPT_TEXT_EXPRESSION |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qBnfDefs` | `array` of [BNFDef](#bnfdef) | |
| `qBnfHash` | `string` | |
Properties of `qBnfDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BNFDef` | [BNFDef](#bnfdef) | |
Properties of `BNFDef`
| Name | Type | Description |
| --- | --- | --- |
| `qBnf` | `array of integer` | Array of token references that all together build up the definition of the current token. Generally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF rules do have an empty array (_qIsBnfRule_ is set to true, but _qBnf_ is empty). |
| `qNbr` | `integer` | Number of the current token definition. |
| `qPNbr` | `integer` | Number of the parent rule definition. |
| `qHelpId` | `integer` | Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name. Is not used in Qlik Sense. |
| `qName` | `string` | Token name. One of: * A rule name * An identifier * A literal value |
| `qStr` | `string` | Literal string of the token. Examples: 'Round' and '('. |
| `qIsBnfRule` | `boolean` | If set to true, a list of related rule tokens is assigned to _qBnf_ . This parameter is optional. The default value is false. |
| `qScriptStatement` | `boolean` | If set to true, the definition specifies a script statement. This parameter is optional. The default value is false. |
| `qControlStatement` | `boolean` | If set to true, the definition specifies a control statement. This parameter is optional. The default value is false. |
| `qBnfLiteral` | `boolean` | If set to true, the definition specifies a literal token. This parameter is optional. The default value is false. |
| `qQvFunc` | `boolean` | If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function. This parameter is optional. The default value is false. |
| `qAggrFunc` | `boolean` | If set to true, the definition is related to an aggregation function. This parameter is optional. The default value is false. |
| `qFG` | oneOf(ALL \| U \| NONE \| AGGR \| NUM \| RNG \| EXP \| TRIG \| FIN \| MATH \| COUNT \| STR \| MAPP \| RCRD \| CND \| LOG \| NULL \| SYS \| FILE \| TBL \| DATE \| NUMI \| FRMT \| CLR \| RNK \| GEO \| EXT \| PROB \| ARRAY \| LEG \| DB \| WINDOW) | |
| `qFieldFlag` | `boolean` | If set to true, the definition is related to a field. This parameter is optional. The default value is false. |
| `qMT` | oneOf(N \| D \| R \| V) | |
| `qDepr` | `boolean` | Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use). If set to true, the script statement or the function is not recommended for use in Qlik Sense. This parameter is optional. The default value is false. |
| `qFGList` | `array` of [FunctionGroup](#functiongroup) | List of groups the function belongs to. |
Properties of `qBnf`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qFG`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
**Option 11:**
_Properties truncated due to depth limit._
**Option 12:**
_Properties truncated due to depth limit._
**Option 13:**
_Properties truncated due to depth limit._
**Option 14:**
_Properties truncated due to depth limit._
**Option 15:**
_Properties truncated due to depth limit._
**Option 16:**
_Properties truncated due to depth limit._
**Option 17:**
_Properties truncated due to depth limit._
**Option 18:**
_Properties truncated due to depth limit._
**Option 19:**
_Properties truncated due to depth limit._
**Option 20:**
_Properties truncated due to depth limit._
**Option 21:**
_Properties truncated due to depth limit._
**Option 22:**
_Properties truncated due to depth limit._
**Option 23:**
_Properties truncated due to depth limit._
**Option 24:**
_Properties truncated due to depth limit._
**Option 25:**
_Properties truncated due to depth limit._
**Option 26:**
_Properties truncated due to depth limit._
**Option 27:**
_Properties truncated due to depth limit._
**Option 28:**
_Properties truncated due to depth limit._
**Option 29:**
_Properties truncated due to depth limit._
**Option 30:**
_Properties truncated due to depth limit._
**Option 31:**
_Properties truncated due to depth limit._
**Option 32:**
_Properties truncated due to depth limit._
Properties of `qMT`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
Properties of `qFGList`
**Array items:**
_Properties truncated due to depth limit._
**See also:**
- [GetBaseBNFHash method](#getbasebnfhash)
---
### GetBaseBNFHash
Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language. If the hash changes between subsequent calls to this method, this indicates that the BNF grammar has changed.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qBnfType` | `string` | Yes | The type of grammar to return: * The script statements and the script functions if _qBnfType_ is set to S. * The chart functions if _qBnfType_ is set to E. One of: * S or SCRIPT_TEXT_SCRIPT * E or SCRIPT_TEXT_EXPRESSION |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qBnfHash` | `string` | |
**See also:**
- [GetBaseBNF method](#getbasebnf)
---
### GetBaseBNFString
Gets the current Backus-Naur Form (BNF) grammar of the Qlik engine scripting language, as well as a string hash calculated from that grammar. The BNF rules define the syntax for the script statements and the script or chart functions. If the hash changes between subsequent calls to this method, this indicates that the BNF has changed.
In the Qlik engine grammars, a token is a string of one or more characters that is significant as a group. For example, a token could be a function name, a number, a letter, a parenthesis, and so on.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qBnfType` | `string` | Yes | The type of grammar to return: * S: returns the script statements and the script functions. * E: returns the chart functions. One of: * S or SCRIPT_TEXT_SCRIPT * E or SCRIPT_TEXT_EXPRESSION |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qBnfStr` | `string` | |
| `qBnfHash` | `string` | |
---
### GetCustomConnectors
**Access control:** `reload`
List the custom connectors available in the system.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qReloadList` | `boolean` | No | Sets if the list of custom connectors should be reloaded or not. If set to false, only the connectors that were returned the previous time are returned. If new connectors have been added since the last call to the _GetCustomConnectors_ method was made, the new connectors are not returned. If set to true, the _GetCustomConnectors_ method looks for new connectors in the file system. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qConnectors` | `array` of [CustomConnector](#customconnector) | |
Properties of `qConnectors`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `CustomConnector` | [CustomConnector](#customconnector) | |
Properties of `CustomConnector`
| Name | Type | Description |
| --- | --- | --- |
| `qProvider` | `string` | Name of the custom connector file. |
| `qParent` | `string` | Name of the parent folder that contains the custom connector file. |
| `qDisplayName` | `string` | Name of the custom connector as displayed in the Qlik interface. |
| `qMachineMode` | oneOf(CONNECT_DEFAULT \| CONNECT_64 \| CONNECT_32) | |
| `qSupportFileStreaming` | `boolean` | |
Properties of `qMachineMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**See also:**
- List the custom connectors
---
### GetDatabasesFromConnectionString
**Access control:** `reload`
Lists the databases in a ODBC, OLEDB or CUSTOM data source.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnection` | [Connection](#connection) | Yes | Information about the connection. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDatabases` | `array` of [Database](#database) | |
Properties of `qDatabases`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `Database` | [Database](#database) | |
Properties of `Database`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the database. |
| `qIsDefault` | `boolean` | Is set to true if the database is set by default. |
**See also:**
- List the databases of a ODBC, OLEDB or CUSTOM connection
---
### GetDefaultAppFolder
**Access control:** `reload`
Returns the folder where the apps are stored.
This method applies only if running Qlik Sense Desktop.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qPath` | `string` | |
**See also:**
- Get the apps folder
---
### GetDocList
Returns the list of apps.
**In Qlik Sense Enterprise:**
The list is generated by the QRS. The GetDocList method only returns documents the current user is allowed to access.
**In Qlik Sense Desktop:**
The apps are located in _C:\Users\<user name>\Documents\Qlik\Sense\Apps_.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDocList` | `array` of [DocListEntry](#doclistentry) | |
Properties of `qDocList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DocListEntry` | [DocListEntry](#doclistentry) | |
Properties of `DocListEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qDocName` | `string` | Name of the app. |
| `qConnectedUsers` | `integer` | Not used. |
| `qFileTime` | `number` | Last modified time stamp of the app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise. |
| `qFileSize` | `number` | Size of remote app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise. |
| `qDocId` | `string` | Identifier of the app. * In Qlik Sense Desktop, the identifier is the path and name of the app. * In Qlik Sense Enterprise, the identifier is the app's GUID. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qLastReloadTime` | `string` | Last reload time of the app. |
| `qReadOnly` | `boolean` | If set to true, the app is read-only. |
| `qTitle` | `string` | Title of the app. |
| `qThumbnail` | [StaticContentUrl](#staticcontenturl) | In addition, this structure can return dynamic properties.
|
| `qHasSectionAccess` | `boolean` | If true the app has section access configured. |
| `qIsDirectQueryMode` | `boolean` | Is the app a Direct Query app? |
| `qUsage` | oneOf(ANALYTICS \| DATA_PREPARATION \| DATAFLOW_PREP \| SINGLE_TABLE_PREP \| DIRECT_QUERY_MODE) | |
Properties of `qMeta`
_Properties truncated due to depth limit._
Properties of `qThumbnail`
_Properties truncated due to depth limit._
Properties of `qUsage`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**See also:**
- List available apps
---
### GetFolderItemsForPath
**Access control:** `reload`
Returns the files and folders located at a specified path.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qPath` | `string` | Yes | Absolute or relative path. Relative paths are relative to the default _Apps_ folder. **In Qlik Sense Enterprise:** The list is generated by the QRS. The GetDocList method only returns documents the current user is allowed to access. **In Qlik Sense Desktop:** The apps are located in _C:\Users\<user name>\Documents\Qlik\Sense\Apps_. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFolderItems` | `array` of [FolderItem](#folderitem) | |
Properties of `qFolderItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FolderItem` | [FolderItem](#folderitem) | |
Properties of `FolderItem`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the folder item. |
| `qType` | oneOf(FOLDER \| FILE \| OTHER) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**See also:**
- List the files and folders in a specified path
---
### GetFunctions
Gets the list of all the script functions.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qGroup` | `string` | No | Name of the group. Default is all groups. One of: * ALL or FUNC_GROUP_ALL * U or FUNC_GROUP_UNKNOWN * NONE or FUNC_GROUP_NONE * AGGR or FUNC_GROUP_AGGR * NUM or FUNC_GROUP_NUMERIC * RNG or FUNC_GROUP_RANGE * EXP or FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC * TRIG or FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC * FIN or FUNC_GROUP_FINANCIAL * MATH or FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE * COUNT or FUNC_GROUP_COUNTER * STR or FUNC_GROUP_STRING * MAPP or FUNC_GROUP_MAPPING * RCRD or FUNC_GROUP_INTER_RECORD * CND or FUNC_GROUP_CONDITIONAL * LOG or FUNC_GROUP_LOGICAL * NULL or FUNC_GROUP_NULL * SYS or FUNC_GROUP_SYSTEM * FILE or FUNC_GROUP_FILE * TBL or FUNC_GROUP_TABLE * DATE or FUNC_GROUP_DATE_AND_TIME * NUMI or FUNC_GROUP_NUMBER_INTERPRET * FRMT or FUNC_GROUP_FORMATTING * CLR or FUNC_GROUP_COLOR * RNK or FUNC_GROUP_RANKING * GEO or FUNC_GROUP_GEO * EXT or FUNC_GROUP_EXTERNAL * PROB or FUNC_GROUP_PROBABILITY * ARRAY or FUNC_GROUP_ARRAY * LEG or FUNC_GROUP_LEGACY * DB or FUNC_GROUP_DB_NATIVE * WINDOW or FUNC_GROUP_WINDOW |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qFunctions` | `array` of [Function](#function) | |
Properties of `qFunctions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `Function` | [Function](#function) | |
Properties of `Function`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the script function. |
| `qGroup` | oneOf(ALL \| U \| NONE \| AGGR \| NUM \| RNG \| EXP \| TRIG \| FIN \| MATH \| COUNT \| STR \| MAPP \| RCRD \| CND \| LOG \| NULL \| SYS \| FILE \| TBL \| DATE \| NUMI \| FRMT \| CLR \| RNK \| GEO \| EXT \| PROB \| ARRAY \| LEG \| DB \| WINDOW) | |
| `qSignature` | `string` | Signature of the script function. Gives general information about the function. |
Properties of `qGroup`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
**Option 11:**
_Properties truncated due to depth limit._
**Option 12:**
_Properties truncated due to depth limit._
**Option 13:**
_Properties truncated due to depth limit._
**Option 14:**
_Properties truncated due to depth limit._
**Option 15:**
_Properties truncated due to depth limit._
**Option 16:**
_Properties truncated due to depth limit._
**Option 17:**
_Properties truncated due to depth limit._
**Option 18:**
_Properties truncated due to depth limit._
**Option 19:**
_Properties truncated due to depth limit._
**Option 20:**
_Properties truncated due to depth limit._
**Option 21:**
_Properties truncated due to depth limit._
**Option 22:**
_Properties truncated due to depth limit._
**Option 23:**
_Properties truncated due to depth limit._
**Option 24:**
_Properties truncated due to depth limit._
**Option 25:**
_Properties truncated due to depth limit._
**Option 26:**
_Properties truncated due to depth limit._
**Option 27:**
_Properties truncated due to depth limit._
**Option 28:**
_Properties truncated due to depth limit._
**Option 29:**
_Properties truncated due to depth limit._
**Option 30:**
_Properties truncated due to depth limit._
**Option 31:**
_Properties truncated due to depth limit._
**Option 32:**
_Properties truncated due to depth limit._
**See also:**
- List the functions
---
### GetInteract
**Access control:** `reload`
Retrieves information on the user interaction that is requested by the engine.
Engine can request user interactions only during script reload and when the reload is performed in debug mode ( _qDebug_ is set to true when using the _DoReload method_ ).
When running reload in debug mode, the engine pauses the script execution to receive data about user interaction. The engine can pause:
* Before executing a new script statement.
* When an error occurs while executing the script.
* When the script execution is finished.
To know if the engine is paused and waits for a response to an interaction request, the _GetProgress method_ should be used. The engine waits for a response if the property _qUserInteractionWanted_ is set to true in the response of the _GetProgress_ request.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qRequestId` | `integer` | Yes | Identifier of the request. Corresponds to the identifier of the _DoReload_ request. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | [InteractDef](#interactdef) | |
| `qReturn` | `boolean` | |
Properties of `qDef`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(IT_MSGBOX \| IT_SCRIPTLINE \| IT_BREAK \| IT_INPUT \| IT_END \| IT_PASSWD \| IT_USERNAME) | |
| `qTitle` | `string` | Title used in the message box dialog. This property is relevant if _qType_ is *IT_MSGBOX*. |
| `qMsg` | `string` | Message used in the message box dialog. This property is relevant if _qType_ is *IT_MSGBOX*. |
| `qButtons` | `integer` | Buttons displayed in the message box dialog. This property is relevant if _qType_ is *IT_MSGBOX*. One of: * 0 means that the _qButtons_ property is not relevant. * 17 means that the message box contains the **OK** and **Cancel** buttons or the **stop** -sign icon. |
| `qLine` | `string` | Next script statement to be executed. This property is used if the type of interaction is *IT_SCRIPTLINE*. |
| `qOldLineNr` | `integer` | First line number of the previously executed statement. This property is used if the type of interaction is *IT_SCRIPTLINE*. |
| `qNewLineNr` | `integer` | First line number of the next statement to be executed. This property is used if the type of interaction is *IT_SCRIPTLINE*. |
| `qPath` | `string` | Path specified by the **Include** script variable. This property is used if the type of interaction is *IT_SCRIPTLINE*. Example of an **Include** variable: _$(Include=lib:\\\MyDataFiles\abc.txt);_ |
| `qHidden` | `boolean` | This property is set to true if the returned statement is an hidden script statement. |
| `qResult` | `integer` | Not relevant for describing the requested user interaction. |
| `qInput` | `string` | Is not used in Qlik Sense. |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_MSGBOX` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_SCRIPTLINE` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_BREAK` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_INPUT` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_END` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_PASSWD` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_USERNAME` | `object` | |
**See also:**
- [InteractDone method](#interactdone)
---
### GetLogicalDriveStrings
**Access control:** `reload`
Lists the logical drives in the system.
This method applies only if running Qlik Sense Desktop.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qDrives` | `array` of [DriveInfo](#driveinfo) | |
Properties of `qDrives`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DriveInfo` | [DriveInfo](#driveinfo) | |
Properties of `DriveInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qDrive` | `string` | Value of the drive. Examples: C:\\\, E:\\\ |
| `qType` | `string` | Type of the drive. _Fixed_ means physical drive. |
| `qName` | `string` | Name of the drive. |
| `qTypeIdentifier` | oneOf(REMOVABLE \| FIXED \| NETWORK \| CD_ROM \| RAM \| UNKNOWN_TYPE) | |
| `qUnnamedDrive` | `boolean` | |
Properties of `qTypeIdentifier`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**See also:**
- List the drives in the system
---
### GetOdbcDsns
**Access control:** `reload`
Returns the list of the ODBC connectors that are installed in the system.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qOdbcDsns` | `array` of [OdbcDsn](#odbcdsn) | |
Properties of `qOdbcDsns`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `OdbcDsn` | [OdbcDsn](#odbcdsn) | |
Properties of `OdbcDsn`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the ODBC connection. |
| `qDescription` | `string` | Description of the ODBC connection. |
| `qBit32` | `boolean` | Is set to true if the version of ODBC is 32-bit. This parameter is optional. Default is false. |
| `qUserOnly` | `boolean` | Is set to true if the connection is User DSN. The connection works only for a specific user. Default is false. This parameter is optional. |
**See also:**
- List the ODBC connections
---
### GetOleDbProviders
**Access control:** `reload`
Returns the list of the OLEDB providers installed on the system.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qOleDbProviders` | `array` of [OleDbProvider](#oledbprovider) | |
Properties of `qOleDbProviders`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `OleDbProvider` | [OleDbProvider](#oledbprovider) | |
Properties of `OleDbProvider`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the OLEDB provider. |
| `qDescription` | `string` | Description of the OLEDB provider. |
| `qBit32` | `boolean` | Is set to true if the version of the OLEDB provider is 32-bit. Default is false. This parameter is optional. |
**See also:**
- List the OLEDB providers
---
### GetProgress
Gives information about the progress of the _DoReload_ and _DoSave_ calls.
For more information on DoReload and DoSave, see the _DoReload Method_ and _DoSave Method_.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qRequestId` | `integer` | Yes | Identifier of the _DoReload_ or _DoSave_ request or 0. Complete information is returned if the identifier of the request is given. If the identifier is 0, less information is given. Progress messages and error messages are returned but information like when the request started and finished is not returned. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProgressData` | [ProgressData](#progressdata) | |
Properties of `qProgressData`
| Name | Type | Description |
| --- | --- | --- |
| `qStarted` | `boolean` | True if the request is started. |
| `qFinished` | `boolean` | True if the request is finished. |
| `qCompleted` | `integer` | This property is not used. |
| `qTotal` | `integer` | This property is not used. |
| `qKB` | `integer` | This property is not used. |
| `qMillisecs` | `integer` | Request duration in milliseconds. |
| `qUserInteractionWanted` | `boolean` | True when the engine pauses the script execution and waits for a user interaction. |
| `qPersistentProgress` | `string` | A progress message is persistent when it informs about the start or end of a statement. For example, it can inform about the total number of lines fetched from a data source or tell that the app was saved. All persistent progress messages between two *GetProgress* calls are summarized in this string. Contrarily to *qPersistentProgressMessages*, the content of the localized message string is displayed (not its message code). |
| `qTransientProgress` | `string` | A progress message is transient when it informs about the progress of an ongoing statement. For example, it can tell how many lines are currently fetched from a data source. All transient progress messages between two *GetProgress* calls are summarized in this string. Contrarily to *qTransientProgressMessage*, the content of the localized message string is displayed (not its message code). |
| `qErrorData` | `array` of [ErrorData](#errordata) | Information about the error messages that occur during the script execution. |
| `qPersistentProgressMessages` | `array` of [ProgressMessage](#progressmessage) | List of persistent progress messages. |
| `qTransientProgressMessage` | [ProgressMessage](#progressmessage) | |
Properties of `qErrorData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ErrorData` | [ErrorData](#errordata) | |
Properties of `ErrorData`
_Properties truncated due to depth limit._
Properties of `qPersistentProgressMessages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ProgressMessage` | [ProgressMessage](#progressmessage) | |
Properties of `ProgressMessage`
_Properties truncated due to depth limit._
Properties of `qTransientProgressMessage`
| Name | Type | Description |
| --- | --- | --- |
| `qMessageCode` | `integer` | Code number to the corresponding localized message string. |
| `qMessageParameters` | `array of string` | Parameters to be inserted in the localized message string. |
Properties of `qMessageParameters`
**Array items:**
_Properties truncated due to depth limit._
**See also:**
- Migrate an app
- Open an app
---
### GetStreamList _(deprecated)_
> **Deprecated:** Use general purpose endpoint in [QRS API: GET qrs/stream/](/Subsystems/RepositoryServiceAPI/Content/Sense_RepositoryServiceAPI/RepositoryServiceAPI-Get.htm) instead.
Lists the streams.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qStreamList` | `array` of [NxStreamListEntry](#nxstreamlistentry) | |
Properties of `qStreamList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxStreamListEntry` | [NxStreamListEntry](#nxstreamlistentry) | This struct is deprecated (not recommended to use).
|
Properties of `NxStreamListEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the stream. |
| `qId` | `string` | Identifier of the stream. |
---
### GetSupportedCodePages
**Access control:** `reload`
Lists the supported code pages.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qCodePages` | `array` of [CodePage](#codepage) | |
Properties of `qCodePages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `CodePage` | [CodePage](#codepage) | |
Properties of `CodePage`
| Name | Type | Description |
| --- | --- | --- |
| `qNumber` | `integer` | Number of the code page. |
| `qName` | `string` | Name of the code page. |
| `qDescription` | `string` | Description of the code page. |
**See also:**
- List the supported code pages
---
### GetUniqueID
Returns the unique identifier of the endpoint for the current user in the current app.
This unique identifier can be used for logging purposes.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qUniqueID` | `string` | |
**See also:**
- Get the identifier of the endpoint
---
### InteractDone
**Access control:** `reload`
Informs the engine that a user interaction (which was earlier requested by the engine) was performed and indicates to the engine what to do next.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qRequestId` | `integer` | Yes | Identifier of the request. Corresponds to the identifier of the _DoReload_ request. |
| `qDef` | [InteractDef](#interactdef) | Yes | User response to the current interaction. |
**Returns:** `object`
**See also:**
- [GetInteract method](#getinteract)
---
### IsDesktopMode
Indicates whether the user is working in Qlik Sense Desktop.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Is the user working in Qlik Sense Desktop?
---
### IsPersonalMode _(deprecated)_
> **Deprecated:** Use _IsDesktopMode_ method instead
Indicates whether or not the user is working in personal mode (Qlik Sense Desktop).
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
**See also:**
- Is the user working in personal mode?
---
### IsValidConnectionString
**Access control:** `reload`
Checks if a connection string is valid.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qConnection` | [Connection](#connection) | Yes | Information about the connection. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### OSName
Returns the name of the operating system.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
**See also:**
- Get the name of the operating system
---
### OSVersion
Returns the version number of the operating system.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
**See also:**
- Get the version of the operating system
---
### OpenDoc
Opens an app and checks if the app needs to be migrated (if the app is deprecated).
The _OpenDoc method_ compares the version of the app with the version of Qlik Sense and migrates the app to the current version of Qlik Sense if necessary. Once the migration is done, the app is opened.
If no migration is needed, the app is opened immediately.
The following applies:
* The app version is lower than 0.95: no migration is done. Apps older than the version 0.95 are not supported.
* The app version is at least 0.95 and less than the Qlik Sense version: the app is migrated and then opened.
* Qlik Sense and the app have the same version: the app is opened, no migration is needed.
If the app is read-only, the app migration cannot occur. An error message is sent.
**Backups**
In Qlik Sense Desktop, apps are automatically backed up before a migration.
The backup files are located in _%userprofile%\Documents\Qlik\Sense\AppsBackup\<Qlik Sense Desktop version>_.
In Qlik Sense Enterprise, no automatic back up is run. The back up should be done manually.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qDocName` | `string` | Yes | The GUID (in Qlik Sense Enterprise) or Name (in Qlik Sense Desktop) of the app to retrieve. |
| `qUserName` | `string` | No | Name of the user that opens the app. |
| `qPassword` | `string` | No | Password of the user. |
| `qSerial` | `string` | No | Current Qlik Sense serial number. |
| `qNoData` | `boolean` | No | Set this parameter to true to be able to open an app without loading its data. When this parameter is set to true, the objects in the app are present but contain no data. The script can be edited and reloaded. The default value is false. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | [ObjectInterface](#objectinterface) | |
Properties of `qReturn`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### ProductVersion _(deprecated)_
> **Deprecated:** Use _EngineVersion_ method instead
Returns the Qlik Sense version number.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
**See also:**
- Get the version of Qlik Sense
---
### PublishApp
**Access control:** `publish`
Publishes an app to the supplied stream.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qAppId` | `string` | Yes | The Id of the app to publish. |
| `qName` | `string` | Yes | The name of the app to publish. |
| `qStreamId` | `string` | Yes | The stream Id of the app to publish. |
**Returns:** `object`
---
### QTProduct
Returns the Qlik product name.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
**See also:**
- Get the name of the Qlik product
---
### QvVersion _(deprecated)_
> **Deprecated:** Use the _EngineVersion_ method instead
Returns the Qlik Sense version number.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
**See also:**
- Get the version of Qlik Sense
---
### ReloadExtensionList
Reloads the list of extensions.
**Returns:** `object`
---
### ReplaceAppFromID
**Access control:** `update`
Replaces objects of a target app with the objects from a source app.
The list of objects in the app to be replaced must be defined in _qIds_.
The data model of the app cannot be updated.
This operation is possible only in Qlik Sense Enterprise.
The operation is successful if **qSuccess** is set to true.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qTargetAppId` | `string` | Yes | Identifier (GUID) of the target app. The target app is the app to be replaced. |
| `qSrcAppID` | `string` | Yes | Identifier (GUID) of the source app. The objects in the source app will replace the objects in the target app. |
| `qIds` | `array of string` | Yes | QRS identifiers (GUID) of the objects in the target app to be replaced. Only QRS-approved GUIDs are applicable. An object that is QRS-approved, is for example an object that has been published (for example, not private anymore). If an object is private, it should not be included in this list. If the array of identifiers contains objects that are not present in the source app, the objects related to these identifiers are removed from the target app. If _qIds_ is empty, no objects are deleted in the target app. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | |
---
### SaveAs _(deprecated)_
> **Deprecated:** Use Document _SaveAs_ method instead
**Access control:** `create`
Save a copy of an app with a different name.
Can be used to save a session app as an ordinary app.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qNewAppName` | `string` | Yes | <Name of the saved app> |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qNewAppId` | `string` | |
---
### ShutdownProcess
Shuts down the Qlik engine.
This operation is possible only in Qlik Sense Desktop.
**Returns:** `object`
**See also:**
- Shut down the Qlik engine
---
## Variable
### ForceContent _(deprecated)_
> **Deprecated:** Use _GenericVariable::SetProperties_ method instead
Sets the value of a dual variable overriding any input constraints.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qs` | `string` | Yes | String representation of a dual value. Set this parameter to "", if the string representation is to be Null. |
| `qd` | `number` | Yes | Numeric representation of a dual value. |
**Returns:** `object`
---
### GetContent _(deprecated)_
> **Deprecated:** Use _GenericVariable::GetProperties_ method instead
Returns the calculated value of a variable.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qContent` | [AlfaNumString](#alfanumstring) | |
Properties of `qContent`
| Name | Type | Description |
| --- | --- | --- |
| `qString` | `string` | Calculated value. |
| `qIsNum` | `boolean` | Is set to true if the value is a numeric. |
---
### GetNxProperties _(deprecated)_
> **Deprecated:** Use _GetProperties_ method instead
Gets the properties of a variable.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qProperties` | [NxVariableProperties](#nxvariableproperties) | |
Properties of `qProperties`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the variable. |
| `qNumberPresentation` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIncludeInBookmark` | `boolean` | Set this property to true to update the variable when applying a bookmark. The value of a variable can affect the state of the selections. The default value is false. |
| `qUsePredefListedValues` | `boolean` | The value of a variable can be an enumeration. Set this property to true to reflect the predefined values in an enumeration. |
| `qPreDefinedList` | `array of string` | List of enumerations. This property is used if _qUsePredefListedValues_ is set to true. |
Properties of `qNumberPresentation`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qPreDefinedList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
**See also:**
- Get the properties of a variable
---
### GetRawContent _(deprecated)_
> **Deprecated:** Use _GenericVariable::GetProperties_ method instead
Returns the raw value of a variable.
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `string` | |
---
### SetContent _(deprecated)_
> **Deprecated:** Use _GenericVariable::SetProperties_ method instead
Sets a value to a variable.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qContent` | `string` | Yes | Value of the variable. |
| `qUpdateMRU` | `boolean` | Yes | If set to true, the value is added to the Most Recently Used (MRU) list. |
**Returns:** `object`
**Response Properties**
| Name | Type | Description |
| --- | --- | --- |
| `qReturn` | `boolean` | |
---
### SetNxProperties _(deprecated)_
> **Deprecated:** Use _SetProperties_ method instead
**Access control:** `update`
Sets some properties to a variable.
**Parameters**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `qProperties` | [NxVariableProperties](#nxvariableproperties) | Yes | Information about the properties of the variable |
**Returns:** `object`
---
## Errors
### GenericErrors
| Name | Type | Description |
| --- | --- | --- |
| `GenericErrors` | oneOf([LOCERR_INTERNAL_ERROR](#locerrinternalerror) \| [LOCERR_GENERIC_UNKNOWN](#locerrgenericunknown) \| [LOCERR_GENERIC_OK](#locerrgenericok) \| [LOCERR_GENERIC_NOT_SET](#locerrgenericnotset) \| [LOCERR_GENERIC_NOT_FOUND](#locerrgenericnotfound) \| [LOCERR_GENERIC_ALREADY_EXISTS](#locerrgenericalreadyexists) \| [LOCERR_GENERIC_INVALID_PATH](#locerrgenericinvalidpath) \| [LOCERR_GENERIC_ACCESS_DENIED](#locerrgenericaccessdenied) \| [LOCERR_GENERIC_OUT_OF_MEMORY](#locerrgenericoutofmemory) \| [LOCERR_GENERIC_NOT_INITIALIZED](#locerrgenericnotinitialized) \| [LOCERR_GENERIC_INVALID_PARAMETERS](#locerrgenericinvalidparameters) \| [LOCERR_GENERIC_EMPTY_PARAMETERS](#locerrgenericemptyparameters) \| [LOCERR_GENERIC_INTERNAL_ERROR](#locerrgenericinternalerror) \| [LOCERR_GENERIC_CORRUPT_DATA](#locerrgenericcorruptdata) \| [LOCERR_GENERIC_MEMORY_INCONSISTENCY](#locerrgenericmemoryinconsistency) \| [LOCERR_GENERIC_INVISIBLE_OWNER_ABORT](#locerrgenericinvisibleownerabort) \| [LOCERR_GENERIC_PROHIBIT_VALIDATE](#locerrgenericprohibitvalidate) \| [LOCERR_GENERIC_ABORTED](#locerrgenericaborted) \| [LOCERR_GENERIC_CONNECTION_LOST](#locerrgenericconnectionlost) \| [LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION](#locerrgenericunsupportedinproductversion) \| [LOCERR_GENERIC_REST_CONNECTION_FAILURE](#locerrgenericrestconnectionfailure) \| [LOCERR_GENERIC_MEMORY_LIMIT_REACHED](#locerrgenericmemorylimitreached) \| [LOCERR_GENERIC_NOT_IMPLEMENTED](#locerrgenericnotimplemented) \| [LOCERR_GENERIC_ENGINE_TERMINATED](#locerrgenericengineterminated) \| [LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED](#locerrgenericwriteoperationslimitreached) \| [LOCERR_HTTP_400](#locerrhttp400) \| [LOCERR_HTTP_401](#locerrhttp401) \| [LOCERR_HTTP_402](#locerrhttp402) \| [LOCERR_HTTP_403](#locerrhttp403) \| [LOCERR_HTTP_404](#locerrhttp404) \| [LOCERR_HTTP_405](#locerrhttp405) \| [LOCERR_HTTP_406](#locerrhttp406) \| [LOCERR_HTTP_407](#locerrhttp407) \| [LOCERR_HTTP_408](#locerrhttp408) \| [LOCERR_HTTP_409](#locerrhttp409) \| [LOCERR_HTTP_410](#locerrhttp410) \| [LOCERR_HTTP_411](#locerrhttp411) \| [LOCERR_HTTP_412](#locerrhttp412) \| [LOCERR_HTTP_413](#locerrhttp413) \| [LOCERR_HTTP_414](#locerrhttp414) \| [LOCERR_HTTP_415](#locerrhttp415) \| [LOCERR_HTTP_416](#locerrhttp416) \| [LOCERR_HTTP_417](#locerrhttp417) \| [LOCERR_HTTP_422](#locerrhttp422) \| [LOCERR_HTTP_423](#locerrhttp423) \| [LOCERR_HTTP_429](#locerrhttp429) \| [LOCERR_HTTP_500](#locerrhttp500) \| [LOCERR_HTTP_501](#locerrhttp501) \| [LOCERR_HTTP_502](#locerrhttp502) \| [LOCERR_HTTP_503](#locerrhttp503) \| [LOCERR_HTTP_504](#locerrhttp504) \| [LOCERR_HTTP_505](#locerrhttp505) \| [LOCERR_HTTP_509](#locerrhttp509) \| [LOCERR_HTTP_COULD_NOT_RESOLVE_HOST](#locerrhttpcouldnotresolvehost) \| [LOCERR_APP_ALREADY_EXISTS](#locerrappalreadyexists) \| [LOCERR_APP_INVALID_NAME](#locerrappinvalidname) \| [LOCERR_APP_ALREADY_OPEN](#locerrappalreadyopen) \| [LOCERR_APP_NOT_FOUND](#locerrappnotfound) \| [LOCERR_APP_IMPORT_FAILED](#locerrappimportfailed) \| [LOCERR_APP_SAVE_FAILED](#locerrappsavefailed) \| [LOCERR_APP_CREATE_FAILED](#locerrappcreatefailed) \| [LOCERR_APP_INVALID](#locerrappinvalid) \| [LOCERR_APP_CONNECT_FAILED](#locerrappconnectfailed) \| [LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE](#locerrappalreadyopenindifferentmode) \| [LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE](#locerrappmigrationcouldnotcontactmigrationservice) \| [LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION](#locerrappmigrationcouldnotstartmigration) \| [LOCERR_APP_MIGRATION_FAILURE](#locerrappmigrationfailure) \| [LOCERR_APP_SCRIPT_MISSING](#locerrappscriptmissing) \| [LOCERR_APP_EXPORT_FAILED](#locerrappexportfailed) \| [LOCERR_APP_SIZE_EXCEEDED](#locerrappsizeexceeded) \| [LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED](#locerrappdirectqueryworkloadnotsupported) \| [LOCERR_APP_NOT_OPEN](#locerrappnotopen) \| [LOCERR_APP_EVENT_SOURCE_TIMEOUT](#locerrappeventsourcetimeout) \| [LOCERR_CONNECTION_ALREADY_EXISTS](#locerrconnectionalreadyexists) \| [LOCERR_CONNECTION_NOT_FOUND](#locerrconnectionnotfound) \| [LOCERR_CONNECTION_FAILED_TO_LOAD](#locerrconnectionfailedtoload) \| [LOCERR_CONNECTION_FAILED_TO_IMPORT](#locerrconnectionfailedtoimport) \| [LOCERR_CONNECTION_NAME_IS_INVALID](#locerrconnectionnameisinvalid) \| [LOCERR_CONNECTION_MISSING_CREDENTIALS](#locerrconnectionmissingcredentials) \| [LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT](#locerrconnectornofilestreamingsupport) \| [LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE](#locerrconnectorfilesizeexceededbuffersize) \| [LOCERR_FILE_ACCESS_DENIED](#locerrfileaccessdenied) \| [LOCERR_FILE_NAME_INVALID](#locerrfilenameinvalid) \| [LOCERR_FILE_CORRUPT](#locerrfilecorrupt) \| [LOCERR_FILE_NOT_FOUND](#locerrfilenotfound) \| [LOCERR_FILE_FORMAT_UNSUPPORTED](#locerrfileformatunsupported) \| [LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE](#locerrfileopenedinunsupportedmode) \| [LOCERR_FILE_TABLE_NOT_FOUND](#locerrfiletablenotfound) \| [LOCERR_USER_ACCESS_DENIED](#locerruseraccessdenied) \| [LOCERR_USER_IMPERSONATION_FAILED](#locerruserimpersonationfailed) \| [LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS](#locerrserveroutofsessionandusercals) \| [LOCERR_SERVER_OUT_OF_SESSION_CALS](#locerrserveroutofsessioncals) \| [LOCERR_SERVER_OUT_OF_USAGE_CALS](#locerrserveroutofusagecals) \| [LOCERR_SERVER_OUT_OF_CALS](#locerrserveroutofcals) \| [LOCERR_SERVER_OUT_OF_NAMED_CALS](#locerrserveroutofnamedcals) \| [LOCERR_SERVER_OFF_DUTY](#locerrserveroffduty) \| [LOCERR_SERVER_BUSY](#locerrserverbusy) \| [LOCERR_SERVER_LICENSE_EXPIRED](#locerrserverlicenseexpired) \| [LOCERR_SERVER_AJAX_DISABLED](#locerrserverajaxdisabled) \| [LOCERR_SERVER_NO_TOKEN](#locerrservernotoken) \| [LOCERR_HC_INVALID_OBJECT](#locerrhcinvalidobject) \| [LOCERR_HC_RESULT_TOO_LARGE](#locerrhcresulttoolarge) \| [LOCERR_HC_INVALID_OBJECT_STATE](#locerrhcinvalidobjectstate) \| [LOCERR_HC_MODAL_OBJECT_ERROR](#locerrhcmodalobjecterror) \| [LOCERR_CALC_INVALID_DEF](#locerrcalcinvaliddef) \| [LOCERR_CALC_NOT_IN_LIB](#locerrcalcnotinlib) \| [LOCERR_CALC_HEAP_ERROR](#locerrcalcheaperror) \| [LOCERR_CALC_TOO_LARGE](#locerrcalctoolarge) \| [LOCERR_CALC_TIMEOUT](#locerrcalctimeout) \| [LOCERR_CALC_EVAL_CONDITION_FAILED](#locerrcalcevalconditionfailed) \| [LOCERR_CALC_MIXED_LINKED_AGGREGATION](#locerrcalcmixedlinkedaggregation) \| [LOCERR_CALC_MISSING_LINKED](#locerrcalcmissinglinked) \| [LOCERR_CALC_INVALID_COL_SORT](#locerrcalcinvalidcolsort) \| [LOCERR_CALC_PAGES_TOO_LARGE](#locerrcalcpagestoolarge) \| [LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED](#locerrcalcsemanticfieldnotallowed) \| [LOCERR_CALC_VALIDATION_STATE_INVALID](#locerrcalcvalidationstateinvalid) \| [LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS](#locerrcalcpivotdimensionsalreadyexists) \| [LOCERR_CALC_MISSING_LINKED_FIELD](#locerrcalcmissinglinkedfield) \| [LOCERR_CALC_NOT_CALCULATED](#locerrcalcnotcalculated) \| [LOCERR_LAYOUT_EXTENDS_INVALID_ID](#locerrlayoutextendsinvalidid) \| [LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND](#locerrlayoutlinkedobjectnotfound) \| [LOCERR_LAYOUT_LINKED_OBJECT_INVALID](#locerrlayoutlinkedobjectinvalid) \| [LOCERR_PERSISTENCE_WRITE_FAILED](#locerrpersistencewritefailed) \| [LOCERR_PERSISTENCE_READ_FAILED](#locerrpersistencereadfailed) \| [LOCERR_PERSISTENCE_DELETE_FAILED](#locerrpersistencedeletefailed) \| [LOCERR_PERSISTENCE_NOT_FOUND](#locerrpersistencenotfound) \| [LOCERR_PERSISTENCE_UNSUPPORTED_VERSION](#locerrpersistenceunsupportedversion) \| [LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY](#locerrpersistencemigrationfailedreadonly) \| [LOCERR_PERSISTENCE_MIGRATION_CANCELLED](#locerrpersistencemigrationcancelled) \| [LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED](#locerrpersistencemigrationbackupfailed) \| [LOCERR_PERSISTENCE_DISK_FULL](#locerrpersistencediskfull) \| [LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP](#locerrpersistencenotsupportedforsessionapp) \| [LOCERR_PERSISTENCE_MOVE_FAILED](#locerrpersistencemovefailed) \| [LOCERR_PERSISTENCE_OBJECT_LOCKED](#locerrpersistenceobjectlocked) \| [LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING](#locerrpersistenceencryptionkeymigrationongoing) \| [LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS](#locerrpersistencesyncsetchunkinvalidparameters) \| [LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS](#locerrpersistencesyncgetchunkinvalidparameters) \| [LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED](#locerrscriptdatasourceaccessdenied) \| [LOCERR_RELOAD_IN_PROGRESS](#locerrreloadinprogress) \| [LOCERR_RELOAD_TABLE_X_NOT_FOUND](#locerrreloadtablexnotfound) \| [LOCERR_RELOAD_UNKNOWN_STATEMENT](#locerrreloadunknownstatement) \| [LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN](#locerrreloadexpectedsomethingfoundunknown) \| [LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN](#locerrreloadexpectednothingfoundunknown) \| [LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof1tokensfoundunknown) \| [LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof2tokensfoundunknown) \| [LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof3tokensfoundunknown) \| [LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof4tokensfoundunknown) \| [LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof5tokensfoundunknown) \| [LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof6tokensfoundunknown) \| [LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof7tokensfoundunknown) \| [LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof8ormoretokensfoundunknown) \| [LOCERR_RELOAD_FIELD_X_NOT_FOUND](#locerrreloadfieldxnotfound) \| [LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND](#locerrreloadmappingtablexnotfound) \| [LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND](#locerrreloadlibconnectionxnotfound) \| [LOCERR_RELOAD_NAME_ALREADY_TAKEN](#locerrreloadnamealreadytaken) \| [LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF](#locerrreloadwrongfileformatdif) \| [LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF](#locerrreloadwrongfileformatbiff) \| [LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED](#locerrreloadwrongfileformatencrypted) \| [LOCERR_RELOAD_OPEN_FILE_ERROR](#locerrreloadopenfileerror) \| [LOCERR_RELOAD_AUTO_GENERATE_COUNT](#locerrreloadautogeneratecount) \| [LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB](#locerrreloadpeillegalprefixcomb) \| [LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR](#locerrreloadmatchingcontrolstatementerror) \| [LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND](#locerrreloadmatchinglibpathxnotfound) \| [LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID](#locerrreloadmatchinglibpathxinvalid) \| [LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE](#locerrreloadmatchinglibpathxoutside) \| [LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE](#locerrreloadnoqualifiedpathforfile) \| [LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS](#locerrreloadmodestatementonlyforlibpaths) \| [LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS](#locerrreloadinconsistentuseofsemanticfields) \| [LOCERR_RELOAD_NO_OPEN_DATABASE](#locerrreloadnoopendatabase) \| [LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY](#locerrreloadaggregationrequiredbygroupby) \| [LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE](#locerrreloadconnectmustuselibprefixinthismode) \| [LOCERR_RELOAD_ODBC_CONNECT_FAILED](#locerrreloadodbcconnectfailed) \| [LOCERR_RELOAD_OLEDB_CONNECT_FAILED](#locerrreloadoledbconnectfailed) \| [LOCERR_RELOAD_CUSTOM_CONNECT_FAILED](#locerrreloadcustomconnectfailed) \| [LOCERR_RELOAD_ODBC_READ_FAILED](#locerrreloadodbcreadfailed) \| [LOCERR_RELOAD_OLEDB_READ_FAILED](#locerrreloadoledbreadfailed) \| [LOCERR_RELOAD_CUSTOM_READ_FAILED](#locerrreloadcustomreadfailed) \| [LOCERR_RELOAD_BINARY_LOAD_PROHIBITED](#locerrreloadbinaryloadprohibited) \| [LOCERR_RELOAD_CONNECTOR_START_FAILED](#locerrreloadconnectorstartfailed) \| [LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING](#locerrreloadconnectornotresponding) \| [LOCERR_RELOAD_CONNECTOR_REPLY_ERROR](#locerrreloadconnectorreplyerror) \| [LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR](#locerrreloadconnectorconnecterror) \| [LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR](#locerrreloadconnectornotfounderror) \| [LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS](#locerrreloadinputfieldwithduplicatekeys) \| [LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE](#locerrreloadconcatenateloadnoprevioustable) \| [LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD](#locerrreloadwrongfileformatqvd) \| [LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT](#locerrreloadactionblockedentitlement) \| [LOCERR_RELOAD_EXIT_ERROR](#locerrreloadexiterror) \| [LOCERR_PERSONAL_NEW_VERSION_AVAILABLE](#locerrpersonalnewversionavailable) \| [LOCERR_PERSONAL_VERSION_EXPIRED](#locerrpersonalversionexpired) \| [LOCERR_PERSONAL_SECTION_ACCESS_DETECTED](#locerrpersonalsectionaccessdetected) \| [LOCERR_PERSONAL_APP_DELETION_FAILED](#locerrpersonalappdeletionfailed) \| [LOCERR_USER_AUTHENTICATION_FAILURE](#locerruserauthenticationfailure) \| [LOCERR_EXPORT_OUT_OF_MEMORY](#locerrexportoutofmemory) \| [LOCERR_EXPORT_NO_DATA](#locerrexportnodata) \| [LOCERR_SYNC_INVALID_OFFSET](#locerrsyncinvalidoffset) \| [LOCERR_SEARCH_TIMEOUT](#locerrsearchtimeout) \| [LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL](#locerrdirectdiscoverylinkedexpressionfail) \| [LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW](#locerrdirectdiscoveryrowcountoverflow) \| [LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT](#locerrdirectdiscoveryemptyresult) \| [LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED](#locerrdirectdiscoverydbconnectionfailed) \| [LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED](#locerrdirectdiscoverymeasurenotallowed) \| [LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED](#locerrdirectdiscoverydetailnotallowed) \| [LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED](#locerrdirectdiscoverynotsynthcircularallowed) \| [LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED](#locerrdirectdiscoveryonlyoneddtableallowed) \| [LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED](#locerrdirectdiscoverydbauthorizationfailed) \| [LOCERR_SMART_LOAD_TABLE_NOT_FOUND](#locerrsmartloadtablenotfound) \| [LOCERR_SMART_LOAD_TABLE_DUPLICATED](#locerrsmartloadtableduplicated) \| [LOCERR_VARIABLE_NO_NAME](#locerrvariablenoname) \| [LOCERR_VARIABLE_DUPLICATE_NAME](#locerrvariableduplicatename) \| [LOCERR_VARIABLE_INCONSISTENCY](#locerrvariableinconsistency) \| [LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY](#locerrvariableconstraintinconsistency) \| [LOCERR_VARIABLE_CONSTRAINT_FAILED](#locerrvariableconstraintfailed) \| [LOCERR_MEDIA_LIBRARY_LIST_FAILED](#locerrmedialibrarylistfailed) \| [LOCERR_MEDIA_LIBRARY_CONTENT_FAILED](#locerrmedialibrarycontentfailed) \| [LOCERR_MEDIA_BUNDLING_FAILED](#locerrmediabundlingfailed) \| [LOCERR_MEDIA_UNBUNDLING_FAILED](#locerrmediaunbundlingfailed) \| [LOCERR_MEDIA_LIBRARY_NOT_FOUND](#locerrmedialibrarynotfound) \| [LOCERR_FEATURE_DISABLED](#locerrfeaturedisabled) \| [LOCERR_LOAD_TOO_MANY_FIELDS](#locerrloadtoomanyfields) \| [LOCERR_LOAD_TOO_MANY_TABLES](#locerrloadtoomanytables) \| [LOCERR_JSON_RPC_INVALID_REQUEST](#locerrjsonrpcinvalidrequest) \| [LOCERR_JSON_RPC_METHOD_NOT_FOUND](#locerrjsonrpcmethodnotfound) \| [LOCERR_JSON_RPC_INVALID_PARAMETERS](#locerrjsonrpcinvalidparameters) \| [LOCERR_JSON_RPC_INTERNAL_ERROR](#locerrjsonrpcinternalerror) \| [LOCERR_JSON_RPC_RESPONSE_TOO_LARGE](#locerrjsonrpcresponsetoolarge) \| [LOCERR_JSON_RPC_PARSE_ERROR](#locerrjsonrpcparseerror) \| [LOCERR_MQ_SOCKET_CONNECT_FAILURE](#locerrmqsocketconnectfailure) \| [LOCERR_MQ_SOCKET_OPEN_FAILURE](#locerrmqsocketopenfailure) \| [LOCERR_MQ_PROTOCOL_NO_RESPONE](#locerrmqprotocolnorespone) \| [LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION](#locerrmqprotocollibraryexception) \| [LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED](#locerrmqprotocolconnectionclosed) \| [LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED](#locerrmqprotocolchannelclosed) \| [LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR](#locerrmqprotocolunknownerror) \| [LOCERR_MQ_PROTOCOL_INVALID_STATUS](#locerrmqprotocolinvalidstatus) \| [LOCERR_EXTENGINE_GRPC_STATUS_OK](#locerrextenginegrpcstatusok) \| [LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED](#locerrextenginegrpcstatuscancelled) \| [LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN](#locerrextenginegrpcstatusunknown) \| [LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT](#locerrextenginegrpcstatusinvalidargument) \| [LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED](#locerrextenginegrpcstatusdeadlineexceeded) \| [LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND](#locerrextenginegrpcstatusnotfound) \| [LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS](#locerrextenginegrpcstatusalreadyexists) \| [LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED](#locerrextenginegrpcstatuspermissiondenied) \| [LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED](#locerrextenginegrpcstatusresourceexhausted) \| [LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION](#locerrextenginegrpcstatusfailedprecondition) \| [LOCERR_EXTENGINE_GRPC_STATUS_ABORTED](#locerrextenginegrpcstatusaborted) \| [LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE](#locerrextenginegrpcstatusoutofrange) \| [LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED](#locerrextenginegrpcstatusunimplemented) \| [LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL](#locerrextenginegrpcstatusinternal) \| [LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE](#locerrextenginegrpcstatusunavailable) \| [LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS](#locerrextenginegrpcstatusdataloss) \| [LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED](#locerrextenginegrpcstatusunauthenticated) \| [LOCERR_LXW_INVALID_OBJ](#locerrlxwinvalidobj) \| [LOCERR_LXW_INVALID_FILE](#locerrlxwinvalidfile) \| [LOCERR_LXW_INVALID_SHEET](#locerrlxwinvalidsheet) \| [LOCERR_LXW_INVALID_EXPORT_RANGE](#locerrlxwinvalidexportrange) \| [LOCERR_LXW_ERROR](#locerrlxwerror) \| [LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED](#locerrlxwerrormemorymallocfailed) \| [LOCERR_LXW_ERROR_CREATING_XLSX_FILE](#locerrlxwerrorcreatingxlsxfile) \| [LOCERR_LXW_ERROR_CREATING_TMPFILE](#locerrlxwerrorcreatingtmpfile) \| [LOCERR_LXW_ERROR_ZIP_FILE_OPERATION](#locerrlxwerrorzipfileoperation) \| [LOCERR_LXW_ERROR_ZIP_FILE_ADD](#locerrlxwerrorzipfileadd) \| [LOCERR_LXW_ERROR_ZIP_CLOSE](#locerrlxwerrorzipclose) \| [LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED](#locerrlxwerrornullparameterignored) \| [LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED](#locerrlxwerrormaxstringlengthexceeded) \| [LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED](#locerrlxwerror255stringlengthexceeded) \| [LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND](#locerrlxwerrorsharedstringindexnotfound) \| [LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE](#locerrlxwerrorworksheetindexoutofrange) \| [LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED](#locerrlxwerrorworksheetmaxnumberurlsexceeded) \| [LOCERR_BDI_STATUS_OK](#locerrbdistatusok) \| [LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED](#locerrbdigenericerrornottranslated) \| [LOCERR_TRENDLINE_INVALID_DEF](#locerrtrendlineinvaliddef) \| [LOCERR_TRENDLINE_INVALID_MATH_ERROR](#locerrtrendlineinvalidmatherror) \| [LOCERR_CURL_UNSUPPORTED_PROTOCOL](#locerrcurlunsupportedprotocol) \| [LOCERR_CURL_COULDNT_RESOLVE_PROXY](#locerrcurlcouldntresolveproxy) \| [LOCERR_CURL_COULDNT_CONNECT](#locerrcurlcouldntconnect) \| [LOCERR_CURL_REMOTE_ACCESS_DENIED](#locerrcurlremoteaccessdenied) \| [LOCERR_CURL_FTP_ACCEPT_FAILED](#locerrcurlftpacceptfailed) \| [LOCERR_CURL_FTP_ACCEPT_TIMEOUT](#locerrcurlftpaccepttimeout) \| [LOCERR_CURL_FTP_CANT_GET_HOST](#locerrcurlftpcantgethost) \| [LOCERR_CURL_PARTIAL_FILE](#locerrcurlpartialfile) \| [LOCERR_CURL_QUOTE_ERROR](#locerrcurlquoteerror) \| [LOCERR_CURL_WRITE_ERROR](#locerrcurlwriteerror) \| [LOCERR_CURL_UPLOAD_FAILED](#locerrcurluploadfailed) \| [LOCERR_CURL_OUT_OF_MEMORY](#locerrcurloutofmemory) \| [LOCERR_CURL_OPERATION_TIMEDOUT](#locerrcurloperationtimedout) \| [LOCERR_CURL_FTP_COULDNT_USE_REST](#locerrcurlftpcouldntuserest) \| [LOCERR_CURL_HTTP_POST_ERROR](#locerrcurlhttpposterror) \| [LOCERR_CURL_SSL_CONNECT_ERROR](#locerrcurlsslconnecterror) \| [LOCERR_CURL_FILE_COULDNT_READ_FILE](#locerrcurlfilecouldntreadfile) \| [LOCERR_CURL_LDAP_CANNOT_BIND](#locerrcurlldapcannotbind) \| [LOCERR_CURL_LDAP_SEARCH_FAILED](#locerrcurlldapsearchfailed) \| [LOCERR_CURL_TOO_MANY_REDIRECTS](#locerrcurltoomanyredirects) \| [LOCERR_CURL_PEER_FAILED_VERIFICATION](#locerrcurlpeerfailedverification) \| [LOCERR_CURL_GOT_NOTHING](#locerrcurlgotnothing) \| [LOCERR_CURL_SSL_ENGINE_NOTFOUND](#locerrcurlsslenginenotfound) \| [LOCERR_CURL_SSL_ENGINE_SETFAILED](#locerrcurlsslenginesetfailed) \| [LOCERR_CURL_SSL_CERTPROBLEM](#locerrcurlsslcertproblem) \| [LOCERR_CURL_SSL_CIPHER](#locerrcurlsslcipher) \| [LOCERR_CURL_SSL_CACERT](#locerrcurlsslcacert) \| [LOCERR_CURL_BAD_CONTENT_ENCODING](#locerrcurlbadcontentencoding) \| [LOCERR_CURL_LDAP_INVALID_URL](#locerrcurlldapinvalidurl) \| [LOCERR_CURL_USE_SSL_FAILED](#locerrcurlusesslfailed) \| [LOCERR_CURL_SSL_ENGINE_INITFAILED](#locerrcurlsslengineinitfailed) \| [LOCERR_CURL_LOGIN_DENIED](#locerrcurllogindenied) \| [LOCERR_CURL_TFTP_NOTFOUND](#locerrcurltftpnotfound) \| [LOCERR_CURL_TFTP_ILLEGAL](#locerrcurltftpillegal) \| [LOCERR_CURL_SSH](#locerrcurlssh) \| [LOCERR_SETEXPRESSION_TOO_LARGE](#locerrsetexpressiontoolarge) \| [LOCERR_RELOAD_MERGE_LOAD_ERROR](#locerrreloadmergeloaderror) \| [LOCERR_WIN_FTP_DROPPED](#locerrwinftpdropped) \| [LOCERR_WIN_FTP_NO_PASSIVE_MODE](#locerrwinftpnopassivemode) \| [LOCERR_WIN_HTTP_DOWNLEVEL_SERVER](#locerrwinhttpdownlevelserver) \| [LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE](#locerrwinhttpinvalidserverresponse) \| [LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION](#locerrwinhttpredirectneedsconfirmation) \| [LOCERR_WIN_INTERNET_FORCE_RETRY](#locerrwininternetforceretry) \| [LOCERR_WIN_INTERNET_CANNOT_CONNECT](#locerrwininternetcannotconnect) \| [LOCERR_WIN_INTERNET_CONNECTION_ABORTED](#locerrwininternetconnectionaborted) \| [LOCERR_WIN_INTERNET_CONNECTION_RESET](#locerrwininternetconnectionreset) \| [LOCERR_WIN_INTERNET_DISCONNECTED](#locerrwininternetdisconnected) \| [LOCERR_WIN_INTERNET_INCORRECT_FORMAT](#locerrwininternetincorrectformat) \| [LOCERR_WIN_INTERNET_INVALID_CA](#locerrwininternetinvalidca) \| [LOCERR_WIN_INTERNET_INVALID_OPERATION](#locerrwininternetinvalidoperation) \| [LOCERR_WIN_INTERNET_INVALID_URL](#locerrwininternetinvalidurl) \| [LOCERR_WIN_INTERNET_ITEM_NOT_FOUND](#locerrwininternetitemnotfound) \| [LOCERR_WIN_INTERNET_LOGIN_FAILURE](#locerrwininternetloginfailure) \| [LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED](#locerrwininternetnamenotresolved) \| [LOCERR_WIN_INTERNET_NEED_UI](#locerrwininternetneedui) \| [LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID](#locerrwininternetseccertcninvalid) \| [LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID](#locerrwininternetseccertdateinvalid) \| [LOCERR_WIN_INTERNET_SEC_CERT_ERRORS](#locerrwininternetseccerterrors) \| [LOCERR_WIN_INTERNET_SEC_INVALID_CERT](#locerrwininternetsecinvalidcert) \| [LOCERR_WIN_INTERNET_SERVER_UNREACHABLE](#locerrwininternetserverunreachable) \| [LOCERR_BM_RESULT_TOO_LARGE](#locerrbmresulttoolarge)) | |
Properties of `GenericErrors`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_INTERNAL_ERROR` | [LOCERR_INTERNAL_ERROR](#locerrinternalerror) | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_UNKNOWN` | [LOCERR_GENERIC_UNKNOWN](#locerrgenericunknown) | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_OK` | [LOCERR_GENERIC_OK](#locerrgenericok) | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_SET` | [LOCERR_GENERIC_NOT_SET](#locerrgenericnotset) | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_FOUND` | [LOCERR_GENERIC_NOT_FOUND](#locerrgenericnotfound) | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ALREADY_EXISTS` | [LOCERR_GENERIC_ALREADY_EXISTS](#locerrgenericalreadyexists) | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVALID_PATH` | [LOCERR_GENERIC_INVALID_PATH](#locerrgenericinvalidpath) | |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ACCESS_DENIED` | [LOCERR_GENERIC_ACCESS_DENIED](#locerrgenericaccessdenied) | |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_OUT_OF_MEMORY` | [LOCERR_GENERIC_OUT_OF_MEMORY](#locerrgenericoutofmemory) | |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_INITIALIZED` | [LOCERR_GENERIC_NOT_INITIALIZED](#locerrgenericnotinitialized) | |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVALID_PARAMETERS` | [LOCERR_GENERIC_INVALID_PARAMETERS](#locerrgenericinvalidparameters) | |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_EMPTY_PARAMETERS` | [LOCERR_GENERIC_EMPTY_PARAMETERS](#locerrgenericemptyparameters) | |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INTERNAL_ERROR` | [LOCERR_GENERIC_INTERNAL_ERROR](#locerrgenericinternalerror) | |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_CORRUPT_DATA` | [LOCERR_GENERIC_CORRUPT_DATA](#locerrgenericcorruptdata) | |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_MEMORY_INCONSISTENCY` | [LOCERR_GENERIC_MEMORY_INCONSISTENCY](#locerrgenericmemoryinconsistency) | |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVISIBLE_OWNER_ABORT` | [LOCERR_GENERIC_INVISIBLE_OWNER_ABORT](#locerrgenericinvisibleownerabort) | |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_PROHIBIT_VALIDATE` | [LOCERR_GENERIC_PROHIBIT_VALIDATE](#locerrgenericprohibitvalidate) | |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ABORTED` | [LOCERR_GENERIC_ABORTED](#locerrgenericaborted) | |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_CONNECTION_LOST` | [LOCERR_GENERIC_CONNECTION_LOST](#locerrgenericconnectionlost) | |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION` | [LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION](#locerrgenericunsupportedinproductversion) | |
**Option 21:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_REST_CONNECTION_FAILURE` | [LOCERR_GENERIC_REST_CONNECTION_FAILURE](#locerrgenericrestconnectionfailure) | |
**Option 22:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_MEMORY_LIMIT_REACHED` | [LOCERR_GENERIC_MEMORY_LIMIT_REACHED](#locerrgenericmemorylimitreached) | |
**Option 23:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_IMPLEMENTED` | [LOCERR_GENERIC_NOT_IMPLEMENTED](#locerrgenericnotimplemented) | |
**Option 24:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ENGINE_TERMINATED` | [LOCERR_GENERIC_ENGINE_TERMINATED](#locerrgenericengineterminated) | |
**Option 25:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED` | [LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED](#locerrgenericwriteoperationslimitreached) | |
**Option 26:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_400` | [LOCERR_HTTP_400](#locerrhttp400) | |
**Option 27:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_401` | [LOCERR_HTTP_401](#locerrhttp401) | |
**Option 28:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_402` | [LOCERR_HTTP_402](#locerrhttp402) | |
**Option 29:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_403` | [LOCERR_HTTP_403](#locerrhttp403) | |
**Option 30:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_404` | [LOCERR_HTTP_404](#locerrhttp404) | |
**Option 31:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_405` | [LOCERR_HTTP_405](#locerrhttp405) | |
**Option 32:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_406` | [LOCERR_HTTP_406](#locerrhttp406) | |
**Option 33:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_407` | [LOCERR_HTTP_407](#locerrhttp407) | |
**Option 34:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_408` | [LOCERR_HTTP_408](#locerrhttp408) | |
**Option 35:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_409` | [LOCERR_HTTP_409](#locerrhttp409) | |
**Option 36:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_410` | [LOCERR_HTTP_410](#locerrhttp410) | |
**Option 37:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_411` | [LOCERR_HTTP_411](#locerrhttp411) | |
**Option 38:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_412` | [LOCERR_HTTP_412](#locerrhttp412) | |
**Option 39:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_413` | [LOCERR_HTTP_413](#locerrhttp413) | |
**Option 40:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_414` | [LOCERR_HTTP_414](#locerrhttp414) | |
**Option 41:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_415` | [LOCERR_HTTP_415](#locerrhttp415) | |
**Option 42:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_416` | [LOCERR_HTTP_416](#locerrhttp416) | |
**Option 43:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_417` | [LOCERR_HTTP_417](#locerrhttp417) | |
**Option 44:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_422` | [LOCERR_HTTP_422](#locerrhttp422) | |
**Option 45:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_423` | [LOCERR_HTTP_423](#locerrhttp423) | |
**Option 46:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_429` | [LOCERR_HTTP_429](#locerrhttp429) | |
**Option 47:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_500` | [LOCERR_HTTP_500](#locerrhttp500) | |
**Option 48:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_501` | [LOCERR_HTTP_501](#locerrhttp501) | |
**Option 49:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_502` | [LOCERR_HTTP_502](#locerrhttp502) | |
**Option 50:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_503` | [LOCERR_HTTP_503](#locerrhttp503) | |
**Option 51:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_504` | [LOCERR_HTTP_504](#locerrhttp504) | |
**Option 52:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_505` | [LOCERR_HTTP_505](#locerrhttp505) | |
**Option 53:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_509` | [LOCERR_HTTP_509](#locerrhttp509) | |
**Option 54:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_COULD_NOT_RESOLVE_HOST` | [LOCERR_HTTP_COULD_NOT_RESOLVE_HOST](#locerrhttpcouldnotresolvehost) | |
**Option 55:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_EXISTS` | [LOCERR_APP_ALREADY_EXISTS](#locerrappalreadyexists) | |
**Option 56:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_INVALID_NAME` | [LOCERR_APP_INVALID_NAME](#locerrappinvalidname) | |
**Option 57:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_OPEN` | [LOCERR_APP_ALREADY_OPEN](#locerrappalreadyopen) | |
**Option 58:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_NOT_FOUND` | [LOCERR_APP_NOT_FOUND](#locerrappnotfound) | |
**Option 59:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_IMPORT_FAILED` | [LOCERR_APP_IMPORT_FAILED](#locerrappimportfailed) | |
**Option 60:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SAVE_FAILED` | [LOCERR_APP_SAVE_FAILED](#locerrappsavefailed) | |
**Option 61:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_CREATE_FAILED` | [LOCERR_APP_CREATE_FAILED](#locerrappcreatefailed) | |
**Option 62:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_INVALID` | [LOCERR_APP_INVALID](#locerrappinvalid) | |
**Option 63:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_CONNECT_FAILED` | [LOCERR_APP_CONNECT_FAILED](#locerrappconnectfailed) | |
**Option 64:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE` | [LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE](#locerrappalreadyopenindifferentmode) | |
**Option 65:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE` | [LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE](#locerrappmigrationcouldnotcontactmigrationservice) | |
**Option 66:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION` | [LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION](#locerrappmigrationcouldnotstartmigration) | |
**Option 67:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_FAILURE` | [LOCERR_APP_MIGRATION_FAILURE](#locerrappmigrationfailure) | |
**Option 68:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SCRIPT_MISSING` | [LOCERR_APP_SCRIPT_MISSING](#locerrappscriptmissing) | |
**Option 69:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_EXPORT_FAILED` | [LOCERR_APP_EXPORT_FAILED](#locerrappexportfailed) | |
**Option 70:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SIZE_EXCEEDED` | [LOCERR_APP_SIZE_EXCEEDED](#locerrappsizeexceeded) | |
**Option 71:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED` | [LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED](#locerrappdirectqueryworkloadnotsupported) | |
**Option 72:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_NOT_OPEN` | [LOCERR_APP_NOT_OPEN](#locerrappnotopen) | |
**Option 73:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_EVENT_SOURCE_TIMEOUT` | [LOCERR_APP_EVENT_SOURCE_TIMEOUT](#locerrappeventsourcetimeout) | |
**Option 74:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_ALREADY_EXISTS` | [LOCERR_CONNECTION_ALREADY_EXISTS](#locerrconnectionalreadyexists) | |
**Option 75:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_NOT_FOUND` | [LOCERR_CONNECTION_NOT_FOUND](#locerrconnectionnotfound) | |
**Option 76:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_FAILED_TO_LOAD` | [LOCERR_CONNECTION_FAILED_TO_LOAD](#locerrconnectionfailedtoload) | |
**Option 77:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_FAILED_TO_IMPORT` | [LOCERR_CONNECTION_FAILED_TO_IMPORT](#locerrconnectionfailedtoimport) | |
**Option 78:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_NAME_IS_INVALID` | [LOCERR_CONNECTION_NAME_IS_INVALID](#locerrconnectionnameisinvalid) | |
**Option 79:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_MISSING_CREDENTIALS` | [LOCERR_CONNECTION_MISSING_CREDENTIALS](#locerrconnectionmissingcredentials) | |
**Option 80:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT` | [LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT](#locerrconnectornofilestreamingsupport) | |
**Option 81:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE` | [LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE](#locerrconnectorfilesizeexceededbuffersize) | |
**Option 82:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_ACCESS_DENIED` | [LOCERR_FILE_ACCESS_DENIED](#locerrfileaccessdenied) | |
**Option 83:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_NAME_INVALID` | [LOCERR_FILE_NAME_INVALID](#locerrfilenameinvalid) | |
**Option 84:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_CORRUPT` | [LOCERR_FILE_CORRUPT](#locerrfilecorrupt) | |
**Option 85:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_NOT_FOUND` | [LOCERR_FILE_NOT_FOUND](#locerrfilenotfound) | |
**Option 86:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_FORMAT_UNSUPPORTED` | [LOCERR_FILE_FORMAT_UNSUPPORTED](#locerrfileformatunsupported) | |
**Option 87:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE` | [LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE](#locerrfileopenedinunsupportedmode) | |
**Option 88:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_TABLE_NOT_FOUND` | [LOCERR_FILE_TABLE_NOT_FOUND](#locerrfiletablenotfound) | |
**Option 89:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_ACCESS_DENIED` | [LOCERR_USER_ACCESS_DENIED](#locerruseraccessdenied) | |
**Option 90:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_IMPERSONATION_FAILED` | [LOCERR_USER_IMPERSONATION_FAILED](#locerruserimpersonationfailed) | |
**Option 91:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS` | [LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS](#locerrserveroutofsessionandusercals) | |
**Option 92:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_SESSION_CALS` | [LOCERR_SERVER_OUT_OF_SESSION_CALS](#locerrserveroutofsessioncals) | |
**Option 93:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_USAGE_CALS` | [LOCERR_SERVER_OUT_OF_USAGE_CALS](#locerrserveroutofusagecals) | |
**Option 94:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_CALS` | [LOCERR_SERVER_OUT_OF_CALS](#locerrserveroutofcals) | |
**Option 95:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_NAMED_CALS` | [LOCERR_SERVER_OUT_OF_NAMED_CALS](#locerrserveroutofnamedcals) | |
**Option 96:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OFF_DUTY` | [LOCERR_SERVER_OFF_DUTY](#locerrserveroffduty) | |
**Option 97:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_BUSY` | [LOCERR_SERVER_BUSY](#locerrserverbusy) | |
**Option 98:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_LICENSE_EXPIRED` | [LOCERR_SERVER_LICENSE_EXPIRED](#locerrserverlicenseexpired) | |
**Option 99:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_AJAX_DISABLED` | [LOCERR_SERVER_AJAX_DISABLED](#locerrserverajaxdisabled) | |
**Option 100:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_NO_TOKEN` | [LOCERR_SERVER_NO_TOKEN](#locerrservernotoken) | |
**Option 101:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_INVALID_OBJECT` | [LOCERR_HC_INVALID_OBJECT](#locerrhcinvalidobject) | |
**Option 102:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_RESULT_TOO_LARGE` | [LOCERR_HC_RESULT_TOO_LARGE](#locerrhcresulttoolarge) | |
**Option 103:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_INVALID_OBJECT_STATE` | [LOCERR_HC_INVALID_OBJECT_STATE](#locerrhcinvalidobjectstate) | |
**Option 104:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_MODAL_OBJECT_ERROR` | [LOCERR_HC_MODAL_OBJECT_ERROR](#locerrhcmodalobjecterror) | |
**Option 105:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_INVALID_DEF` | [LOCERR_CALC_INVALID_DEF](#locerrcalcinvaliddef) | |
**Option 106:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_NOT_IN_LIB` | [LOCERR_CALC_NOT_IN_LIB](#locerrcalcnotinlib) | |
**Option 107:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_HEAP_ERROR` | [LOCERR_CALC_HEAP_ERROR](#locerrcalcheaperror) | |
**Option 108:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_TOO_LARGE` | [LOCERR_CALC_TOO_LARGE](#locerrcalctoolarge) | |
**Option 109:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_TIMEOUT` | [LOCERR_CALC_TIMEOUT](#locerrcalctimeout) | |
**Option 110:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_EVAL_CONDITION_FAILED` | [LOCERR_CALC_EVAL_CONDITION_FAILED](#locerrcalcevalconditionfailed) | |
**Option 111:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MIXED_LINKED_AGGREGATION` | [LOCERR_CALC_MIXED_LINKED_AGGREGATION](#locerrcalcmixedlinkedaggregation) | |
**Option 112:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MISSING_LINKED` | [LOCERR_CALC_MISSING_LINKED](#locerrcalcmissinglinked) | |
**Option 113:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_INVALID_COL_SORT` | [LOCERR_CALC_INVALID_COL_SORT](#locerrcalcinvalidcolsort) | |
**Option 114:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_PAGES_TOO_LARGE` | [LOCERR_CALC_PAGES_TOO_LARGE](#locerrcalcpagestoolarge) | |
**Option 115:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED` | [LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED](#locerrcalcsemanticfieldnotallowed) | |
**Option 116:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_VALIDATION_STATE_INVALID` | [LOCERR_CALC_VALIDATION_STATE_INVALID](#locerrcalcvalidationstateinvalid) | |
**Option 117:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS` | [LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS](#locerrcalcpivotdimensionsalreadyexists) | |
**Option 118:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MISSING_LINKED_FIELD` | [LOCERR_CALC_MISSING_LINKED_FIELD](#locerrcalcmissinglinkedfield) | |
**Option 119:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_NOT_CALCULATED` | [LOCERR_CALC_NOT_CALCULATED](#locerrcalcnotcalculated) | |
**Option 120:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_EXTENDS_INVALID_ID` | [LOCERR_LAYOUT_EXTENDS_INVALID_ID](#locerrlayoutextendsinvalidid) | |
**Option 121:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND` | [LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND](#locerrlayoutlinkedobjectnotfound) | |
**Option 122:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_LINKED_OBJECT_INVALID` | [LOCERR_LAYOUT_LINKED_OBJECT_INVALID](#locerrlayoutlinkedobjectinvalid) | |
**Option 123:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_WRITE_FAILED` | [LOCERR_PERSISTENCE_WRITE_FAILED](#locerrpersistencewritefailed) | |
**Option 124:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_READ_FAILED` | [LOCERR_PERSISTENCE_READ_FAILED](#locerrpersistencereadfailed) | |
**Option 125:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_DELETE_FAILED` | [LOCERR_PERSISTENCE_DELETE_FAILED](#locerrpersistencedeletefailed) | |
**Option 126:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_NOT_FOUND` | [LOCERR_PERSISTENCE_NOT_FOUND](#locerrpersistencenotfound) | |
**Option 127:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_UNSUPPORTED_VERSION` | [LOCERR_PERSISTENCE_UNSUPPORTED_VERSION](#locerrpersistenceunsupportedversion) | |
**Option 128:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY` | [LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY](#locerrpersistencemigrationfailedreadonly) | |
**Option 129:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_CANCELLED` | [LOCERR_PERSISTENCE_MIGRATION_CANCELLED](#locerrpersistencemigrationcancelled) | |
**Option 130:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED` | [LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED](#locerrpersistencemigrationbackupfailed) | |
**Option 131:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_DISK_FULL` | [LOCERR_PERSISTENCE_DISK_FULL](#locerrpersistencediskfull) | |
**Option 132:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP` | [LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP](#locerrpersistencenotsupportedforsessionapp) | |
**Option 133:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MOVE_FAILED` | [LOCERR_PERSISTENCE_MOVE_FAILED](#locerrpersistencemovefailed) | |
**Option 134:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_OBJECT_LOCKED` | [LOCERR_PERSISTENCE_OBJECT_LOCKED](#locerrpersistenceobjectlocked) | |
**Option 135:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING` | [LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING](#locerrpersistenceencryptionkeymigrationongoing) | |
**Option 136:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS` | [LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS](#locerrpersistencesyncsetchunkinvalidparameters) | |
**Option 137:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS` | [LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS](#locerrpersistencesyncgetchunkinvalidparameters) | |
**Option 138:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED` | [LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED](#locerrscriptdatasourceaccessdenied) | |
**Option 139:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_IN_PROGRESS` | [LOCERR_RELOAD_IN_PROGRESS](#locerrreloadinprogress) | |
**Option 140:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_TABLE_X_NOT_FOUND` | [LOCERR_RELOAD_TABLE_X_NOT_FOUND](#locerrreloadtablexnotfound) | |
**Option 141:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_UNKNOWN_STATEMENT` | [LOCERR_RELOAD_UNKNOWN_STATEMENT](#locerrreloadunknownstatement) | |
**Option 142:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN](#locerrreloadexpectedsomethingfoundunknown) | |
**Option 143:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN](#locerrreloadexpectednothingfoundunknown) | |
**Option 144:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof1tokensfoundunknown) | |
**Option 145:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof2tokensfoundunknown) | |
**Option 146:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof3tokensfoundunknown) | |
**Option 147:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof4tokensfoundunknown) | |
**Option 148:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof5tokensfoundunknown) | |
**Option 149:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof6tokensfoundunknown) | |
**Option 150:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof7tokensfoundunknown) | |
**Option 151:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN` | [LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN](#locerrreloadexpectedoneof8ormoretokensfoundunknown) | |
**Option 152:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_FIELD_X_NOT_FOUND` | [LOCERR_RELOAD_FIELD_X_NOT_FOUND](#locerrreloadfieldxnotfound) | |
**Option 153:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND` | [LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND](#locerrreloadmappingtablexnotfound) | |
**Option 154:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND` | [LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND](#locerrreloadlibconnectionxnotfound) | |
**Option 155:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NAME_ALREADY_TAKEN` | [LOCERR_RELOAD_NAME_ALREADY_TAKEN](#locerrreloadnamealreadytaken) | |
**Option 156:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF` | [LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF](#locerrreloadwrongfileformatdif) | |
**Option 157:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF` | [LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF](#locerrreloadwrongfileformatbiff) | |
**Option 158:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED` | [LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED](#locerrreloadwrongfileformatencrypted) | |
**Option 159:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OPEN_FILE_ERROR` | [LOCERR_RELOAD_OPEN_FILE_ERROR](#locerrreloadopenfileerror) | |
**Option 160:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_AUTO_GENERATE_COUNT` | [LOCERR_RELOAD_AUTO_GENERATE_COUNT](#locerrreloadautogeneratecount) | |
**Option 161:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB` | [LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB](#locerrreloadpeillegalprefixcomb) | |
**Option 162:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR` | [LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR](#locerrreloadmatchingcontrolstatementerror) | |
**Option 163:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND` | [LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND](#locerrreloadmatchinglibpathxnotfound) | |
**Option 164:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID` | [LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID](#locerrreloadmatchinglibpathxinvalid) | |
**Option 165:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE` | [LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE](#locerrreloadmatchinglibpathxoutside) | |
**Option 166:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE` | [LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE](#locerrreloadnoqualifiedpathforfile) | |
**Option 167:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS` | [LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS](#locerrreloadmodestatementonlyforlibpaths) | |
**Option 168:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS` | [LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS](#locerrreloadinconsistentuseofsemanticfields) | |
**Option 169:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NO_OPEN_DATABASE` | [LOCERR_RELOAD_NO_OPEN_DATABASE](#locerrreloadnoopendatabase) | |
**Option 170:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY` | [LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY](#locerrreloadaggregationrequiredbygroupby) | |
**Option 171:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE` | [LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE](#locerrreloadconnectmustuselibprefixinthismode) | |
**Option 172:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ODBC_CONNECT_FAILED` | [LOCERR_RELOAD_ODBC_CONNECT_FAILED](#locerrreloadodbcconnectfailed) | |
**Option 173:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OLEDB_CONNECT_FAILED` | [LOCERR_RELOAD_OLEDB_CONNECT_FAILED](#locerrreloadoledbconnectfailed) | |
**Option 174:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CUSTOM_CONNECT_FAILED` | [LOCERR_RELOAD_CUSTOM_CONNECT_FAILED](#locerrreloadcustomconnectfailed) | |
**Option 175:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ODBC_READ_FAILED` | [LOCERR_RELOAD_ODBC_READ_FAILED](#locerrreloadodbcreadfailed) | |
**Option 176:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OLEDB_READ_FAILED` | [LOCERR_RELOAD_OLEDB_READ_FAILED](#locerrreloadoledbreadfailed) | |
**Option 177:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CUSTOM_READ_FAILED` | [LOCERR_RELOAD_CUSTOM_READ_FAILED](#locerrreloadcustomreadfailed) | |
**Option 178:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_BINARY_LOAD_PROHIBITED` | [LOCERR_RELOAD_BINARY_LOAD_PROHIBITED](#locerrreloadbinaryloadprohibited) | |
**Option 179:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_START_FAILED` | [LOCERR_RELOAD_CONNECTOR_START_FAILED](#locerrreloadconnectorstartfailed) | |
**Option 180:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING` | [LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING](#locerrreloadconnectornotresponding) | |
**Option 181:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_REPLY_ERROR` | [LOCERR_RELOAD_CONNECTOR_REPLY_ERROR](#locerrreloadconnectorreplyerror) | |
**Option 182:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR` | [LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR](#locerrreloadconnectorconnecterror) | |
**Option 183:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR` | [LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR](#locerrreloadconnectornotfounderror) | |
**Option 184:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS` | [LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS](#locerrreloadinputfieldwithduplicatekeys) | |
**Option 185:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE` | [LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE](#locerrreloadconcatenateloadnoprevioustable) | |
**Option 186:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD` | [LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD](#locerrreloadwrongfileformatqvd) | |
**Option 187:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT` | [LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT](#locerrreloadactionblockedentitlement) | |
**Option 188:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXIT_ERROR` | [LOCERR_RELOAD_EXIT_ERROR](#locerrreloadexiterror) | |
**Option 189:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_NEW_VERSION_AVAILABLE` | [LOCERR_PERSONAL_NEW_VERSION_AVAILABLE](#locerrpersonalnewversionavailable) | |
**Option 190:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_VERSION_EXPIRED` | [LOCERR_PERSONAL_VERSION_EXPIRED](#locerrpersonalversionexpired) | |
**Option 191:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_SECTION_ACCESS_DETECTED` | [LOCERR_PERSONAL_SECTION_ACCESS_DETECTED](#locerrpersonalsectionaccessdetected) | |
**Option 192:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_APP_DELETION_FAILED` | [LOCERR_PERSONAL_APP_DELETION_FAILED](#locerrpersonalappdeletionfailed) | |
**Option 193:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_AUTHENTICATION_FAILURE` | [LOCERR_USER_AUTHENTICATION_FAILURE](#locerruserauthenticationfailure) | |
**Option 194:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXPORT_OUT_OF_MEMORY` | [LOCERR_EXPORT_OUT_OF_MEMORY](#locerrexportoutofmemory) | |
**Option 195:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXPORT_NO_DATA` | [LOCERR_EXPORT_NO_DATA](#locerrexportnodata) | |
**Option 196:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SYNC_INVALID_OFFSET` | [LOCERR_SYNC_INVALID_OFFSET](#locerrsyncinvalidoffset) | |
**Option 197:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SEARCH_TIMEOUT` | [LOCERR_SEARCH_TIMEOUT](#locerrsearchtimeout) | |
**Option 198:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL` | [LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL](#locerrdirectdiscoverylinkedexpressionfail) | |
**Option 199:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW` | [LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW](#locerrdirectdiscoveryrowcountoverflow) | |
**Option 200:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT` | [LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT](#locerrdirectdiscoveryemptyresult) | |
**Option 201:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED` | [LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED](#locerrdirectdiscoverydbconnectionfailed) | |
**Option 202:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED` | [LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED](#locerrdirectdiscoverymeasurenotallowed) | |
**Option 203:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED` | [LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED](#locerrdirectdiscoverydetailnotallowed) | |
**Option 204:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED` | [LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED](#locerrdirectdiscoverynotsynthcircularallowed) | |
**Option 205:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED` | [LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED](#locerrdirectdiscoveryonlyoneddtableallowed) | |
**Option 206:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED` | [LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED](#locerrdirectdiscoverydbauthorizationfailed) | |
**Option 207:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SMART_LOAD_TABLE_NOT_FOUND` | [LOCERR_SMART_LOAD_TABLE_NOT_FOUND](#locerrsmartloadtablenotfound) | |
**Option 208:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SMART_LOAD_TABLE_DUPLICATED` | [LOCERR_SMART_LOAD_TABLE_DUPLICATED](#locerrsmartloadtableduplicated) | |
**Option 209:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_NO_NAME` | [LOCERR_VARIABLE_NO_NAME](#locerrvariablenoname) | |
**Option 210:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_DUPLICATE_NAME` | [LOCERR_VARIABLE_DUPLICATE_NAME](#locerrvariableduplicatename) | |
**Option 211:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_INCONSISTENCY` | [LOCERR_VARIABLE_INCONSISTENCY](#locerrvariableinconsistency) | |
**Option 212:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY` | [LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY](#locerrvariableconstraintinconsistency) | |
**Option 213:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_CONSTRAINT_FAILED` | [LOCERR_VARIABLE_CONSTRAINT_FAILED](#locerrvariableconstraintfailed) | |
**Option 214:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_LIST_FAILED` | [LOCERR_MEDIA_LIBRARY_LIST_FAILED](#locerrmedialibrarylistfailed) | |
**Option 215:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_CONTENT_FAILED` | [LOCERR_MEDIA_LIBRARY_CONTENT_FAILED](#locerrmedialibrarycontentfailed) | |
**Option 216:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_BUNDLING_FAILED` | [LOCERR_MEDIA_BUNDLING_FAILED](#locerrmediabundlingfailed) | |
**Option 217:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_UNBUNDLING_FAILED` | [LOCERR_MEDIA_UNBUNDLING_FAILED](#locerrmediaunbundlingfailed) | |
**Option 218:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_NOT_FOUND` | [LOCERR_MEDIA_LIBRARY_NOT_FOUND](#locerrmedialibrarynotfound) | |
**Option 219:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FEATURE_DISABLED` | [LOCERR_FEATURE_DISABLED](#locerrfeaturedisabled) | |
**Option 220:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LOAD_TOO_MANY_FIELDS` | [LOCERR_LOAD_TOO_MANY_FIELDS](#locerrloadtoomanyfields) | |
**Option 221:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LOAD_TOO_MANY_TABLES` | [LOCERR_LOAD_TOO_MANY_TABLES](#locerrloadtoomanytables) | |
**Option 222:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INVALID_REQUEST` | [LOCERR_JSON_RPC_INVALID_REQUEST](#locerrjsonrpcinvalidrequest) | |
**Option 223:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_METHOD_NOT_FOUND` | [LOCERR_JSON_RPC_METHOD_NOT_FOUND](#locerrjsonrpcmethodnotfound) | |
**Option 224:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INVALID_PARAMETERS` | [LOCERR_JSON_RPC_INVALID_PARAMETERS](#locerrjsonrpcinvalidparameters) | |
**Option 225:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INTERNAL_ERROR` | [LOCERR_JSON_RPC_INTERNAL_ERROR](#locerrjsonrpcinternalerror) | |
**Option 226:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_RESPONSE_TOO_LARGE` | [LOCERR_JSON_RPC_RESPONSE_TOO_LARGE](#locerrjsonrpcresponsetoolarge) | |
**Option 227:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_PARSE_ERROR` | [LOCERR_JSON_RPC_PARSE_ERROR](#locerrjsonrpcparseerror) | |
**Option 228:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_SOCKET_CONNECT_FAILURE` | [LOCERR_MQ_SOCKET_CONNECT_FAILURE](#locerrmqsocketconnectfailure) | |
**Option 229:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_SOCKET_OPEN_FAILURE` | [LOCERR_MQ_SOCKET_OPEN_FAILURE](#locerrmqsocketopenfailure) | |
**Option 230:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_NO_RESPONE` | [LOCERR_MQ_PROTOCOL_NO_RESPONE](#locerrmqprotocolnorespone) | |
**Option 231:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION` | [LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION](#locerrmqprotocollibraryexception) | |
**Option 232:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED` | [LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED](#locerrmqprotocolconnectionclosed) | |
**Option 233:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED` | [LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED](#locerrmqprotocolchannelclosed) | |
**Option 234:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR` | [LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR](#locerrmqprotocolunknownerror) | |
**Option 235:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_INVALID_STATUS` | [LOCERR_MQ_PROTOCOL_INVALID_STATUS](#locerrmqprotocolinvalidstatus) | |
**Option 236:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_OK` | [LOCERR_EXTENGINE_GRPC_STATUS_OK](#locerrextenginegrpcstatusok) | |
**Option 237:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED` | [LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED](#locerrextenginegrpcstatuscancelled) | |
**Option 238:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN` | [LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN](#locerrextenginegrpcstatusunknown) | |
**Option 239:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT` | [LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT](#locerrextenginegrpcstatusinvalidargument) | |
**Option 240:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED` | [LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED](#locerrextenginegrpcstatusdeadlineexceeded) | |
**Option 241:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND` | [LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND](#locerrextenginegrpcstatusnotfound) | |
**Option 242:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS` | [LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS](#locerrextenginegrpcstatusalreadyexists) | |
**Option 243:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED` | [LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED](#locerrextenginegrpcstatuspermissiondenied) | |
**Option 244:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED` | [LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED](#locerrextenginegrpcstatusresourceexhausted) | |
**Option 245:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION` | [LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION](#locerrextenginegrpcstatusfailedprecondition) | |
**Option 246:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_ABORTED` | [LOCERR_EXTENGINE_GRPC_STATUS_ABORTED](#locerrextenginegrpcstatusaborted) | |
**Option 247:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE` | [LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE](#locerrextenginegrpcstatusoutofrange) | |
**Option 248:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED` | [LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED](#locerrextenginegrpcstatusunimplemented) | |
**Option 249:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL` | [LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL](#locerrextenginegrpcstatusinternal) | |
**Option 250:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE` | [LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE](#locerrextenginegrpcstatusunavailable) | |
**Option 251:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS` | [LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS](#locerrextenginegrpcstatusdataloss) | |
**Option 252:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED` | [LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED](#locerrextenginegrpcstatusunauthenticated) | |
**Option 253:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_OBJ` | [LOCERR_LXW_INVALID_OBJ](#locerrlxwinvalidobj) | |
**Option 254:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_FILE` | [LOCERR_LXW_INVALID_FILE](#locerrlxwinvalidfile) | |
**Option 255:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_SHEET` | [LOCERR_LXW_INVALID_SHEET](#locerrlxwinvalidsheet) | |
**Option 256:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_EXPORT_RANGE` | [LOCERR_LXW_INVALID_EXPORT_RANGE](#locerrlxwinvalidexportrange) | |
**Option 257:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR` | [LOCERR_LXW_ERROR](#locerrlxwerror) | |
**Option 258:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED` | [LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED](#locerrlxwerrormemorymallocfailed) | |
**Option 259:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_CREATING_XLSX_FILE` | [LOCERR_LXW_ERROR_CREATING_XLSX_FILE](#locerrlxwerrorcreatingxlsxfile) | |
**Option 260:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_CREATING_TMPFILE` | [LOCERR_LXW_ERROR_CREATING_TMPFILE](#locerrlxwerrorcreatingtmpfile) | |
**Option 261:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_FILE_OPERATION` | [LOCERR_LXW_ERROR_ZIP_FILE_OPERATION](#locerrlxwerrorzipfileoperation) | |
**Option 262:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_FILE_ADD` | [LOCERR_LXW_ERROR_ZIP_FILE_ADD](#locerrlxwerrorzipfileadd) | |
**Option 263:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_CLOSE` | [LOCERR_LXW_ERROR_ZIP_CLOSE](#locerrlxwerrorzipclose) | |
**Option 264:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED` | [LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED](#locerrlxwerrornullparameterignored) | |
**Option 265:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED` | [LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED](#locerrlxwerrormaxstringlengthexceeded) | |
**Option 266:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED` | [LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED](#locerrlxwerror255stringlengthexceeded) | |
**Option 267:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND` | [LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND](#locerrlxwerrorsharedstringindexnotfound) | |
**Option 268:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE` | [LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE](#locerrlxwerrorworksheetindexoutofrange) | |
**Option 269:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED` | [LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED](#locerrlxwerrorworksheetmaxnumberurlsexceeded) | |
**Option 270:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BDI_STATUS_OK` | [LOCERR_BDI_STATUS_OK](#locerrbdistatusok) | |
**Option 271:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED` | [LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED](#locerrbdigenericerrornottranslated) | |
**Option 272:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_TRENDLINE_INVALID_DEF` | [LOCERR_TRENDLINE_INVALID_DEF](#locerrtrendlineinvaliddef) | |
**Option 273:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_TRENDLINE_INVALID_MATH_ERROR` | [LOCERR_TRENDLINE_INVALID_MATH_ERROR](#locerrtrendlineinvalidmatherror) | |
**Option 274:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_UNSUPPORTED_PROTOCOL` | [LOCERR_CURL_UNSUPPORTED_PROTOCOL](#locerrcurlunsupportedprotocol) | |
**Option 275:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_COULDNT_RESOLVE_PROXY` | [LOCERR_CURL_COULDNT_RESOLVE_PROXY](#locerrcurlcouldntresolveproxy) | |
**Option 276:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_COULDNT_CONNECT` | [LOCERR_CURL_COULDNT_CONNECT](#locerrcurlcouldntconnect) | |
**Option 277:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_REMOTE_ACCESS_DENIED` | [LOCERR_CURL_REMOTE_ACCESS_DENIED](#locerrcurlremoteaccessdenied) | |
**Option 278:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_ACCEPT_FAILED` | [LOCERR_CURL_FTP_ACCEPT_FAILED](#locerrcurlftpacceptfailed) | |
**Option 279:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_ACCEPT_TIMEOUT` | [LOCERR_CURL_FTP_ACCEPT_TIMEOUT](#locerrcurlftpaccepttimeout) | |
**Option 280:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_CANT_GET_HOST` | [LOCERR_CURL_FTP_CANT_GET_HOST](#locerrcurlftpcantgethost) | |
**Option 281:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_PARTIAL_FILE` | [LOCERR_CURL_PARTIAL_FILE](#locerrcurlpartialfile) | |
**Option 282:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_QUOTE_ERROR` | [LOCERR_CURL_QUOTE_ERROR](#locerrcurlquoteerror) | |
**Option 283:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_WRITE_ERROR` | [LOCERR_CURL_WRITE_ERROR](#locerrcurlwriteerror) | |
**Option 284:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_UPLOAD_FAILED` | [LOCERR_CURL_UPLOAD_FAILED](#locerrcurluploadfailed) | |
**Option 285:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_OUT_OF_MEMORY` | [LOCERR_CURL_OUT_OF_MEMORY](#locerrcurloutofmemory) | |
**Option 286:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_OPERATION_TIMEDOUT` | [LOCERR_CURL_OPERATION_TIMEDOUT](#locerrcurloperationtimedout) | |
**Option 287:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_COULDNT_USE_REST` | [LOCERR_CURL_FTP_COULDNT_USE_REST](#locerrcurlftpcouldntuserest) | |
**Option 288:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_HTTP_POST_ERROR` | [LOCERR_CURL_HTTP_POST_ERROR](#locerrcurlhttpposterror) | |
**Option 289:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CONNECT_ERROR` | [LOCERR_CURL_SSL_CONNECT_ERROR](#locerrcurlsslconnecterror) | |
**Option 290:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FILE_COULDNT_READ_FILE` | [LOCERR_CURL_FILE_COULDNT_READ_FILE](#locerrcurlfilecouldntreadfile) | |
**Option 291:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_CANNOT_BIND` | [LOCERR_CURL_LDAP_CANNOT_BIND](#locerrcurlldapcannotbind) | |
**Option 292:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_SEARCH_FAILED` | [LOCERR_CURL_LDAP_SEARCH_FAILED](#locerrcurlldapsearchfailed) | |
**Option 293:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TOO_MANY_REDIRECTS` | [LOCERR_CURL_TOO_MANY_REDIRECTS](#locerrcurltoomanyredirects) | |
**Option 294:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_PEER_FAILED_VERIFICATION` | [LOCERR_CURL_PEER_FAILED_VERIFICATION](#locerrcurlpeerfailedverification) | |
**Option 295:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_GOT_NOTHING` | [LOCERR_CURL_GOT_NOTHING](#locerrcurlgotnothing) | |
**Option 296:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_NOTFOUND` | [LOCERR_CURL_SSL_ENGINE_NOTFOUND](#locerrcurlsslenginenotfound) | |
**Option 297:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_SETFAILED` | [LOCERR_CURL_SSL_ENGINE_SETFAILED](#locerrcurlsslenginesetfailed) | |
**Option 298:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CERTPROBLEM` | [LOCERR_CURL_SSL_CERTPROBLEM](#locerrcurlsslcertproblem) | |
**Option 299:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CIPHER` | [LOCERR_CURL_SSL_CIPHER](#locerrcurlsslcipher) | |
**Option 300:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CACERT` | [LOCERR_CURL_SSL_CACERT](#locerrcurlsslcacert) | |
**Option 301:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_BAD_CONTENT_ENCODING` | [LOCERR_CURL_BAD_CONTENT_ENCODING](#locerrcurlbadcontentencoding) | |
**Option 302:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_INVALID_URL` | [LOCERR_CURL_LDAP_INVALID_URL](#locerrcurlldapinvalidurl) | |
**Option 303:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_USE_SSL_FAILED` | [LOCERR_CURL_USE_SSL_FAILED](#locerrcurlusesslfailed) | |
**Option 304:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_INITFAILED` | [LOCERR_CURL_SSL_ENGINE_INITFAILED](#locerrcurlsslengineinitfailed) | |
**Option 305:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LOGIN_DENIED` | [LOCERR_CURL_LOGIN_DENIED](#locerrcurllogindenied) | |
**Option 306:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TFTP_NOTFOUND` | [LOCERR_CURL_TFTP_NOTFOUND](#locerrcurltftpnotfound) | |
**Option 307:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TFTP_ILLEGAL` | [LOCERR_CURL_TFTP_ILLEGAL](#locerrcurltftpillegal) | |
**Option 308:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSH` | [LOCERR_CURL_SSH](#locerrcurlssh) | |
**Option 309:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SETEXPRESSION_TOO_LARGE` | [LOCERR_SETEXPRESSION_TOO_LARGE](#locerrsetexpressiontoolarge) | |
**Option 310:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MERGE_LOAD_ERROR` | [LOCERR_RELOAD_MERGE_LOAD_ERROR](#locerrreloadmergeloaderror) | |
**Option 311:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_FTP_DROPPED` | [LOCERR_WIN_FTP_DROPPED](#locerrwinftpdropped) | |
**Option 312:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_FTP_NO_PASSIVE_MODE` | [LOCERR_WIN_FTP_NO_PASSIVE_MODE](#locerrwinftpnopassivemode) | |
**Option 313:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_DOWNLEVEL_SERVER` | [LOCERR_WIN_HTTP_DOWNLEVEL_SERVER](#locerrwinhttpdownlevelserver) | |
**Option 314:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE` | [LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE](#locerrwinhttpinvalidserverresponse) | |
**Option 315:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION` | [LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION](#locerrwinhttpredirectneedsconfirmation) | |
**Option 316:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_FORCE_RETRY` | [LOCERR_WIN_INTERNET_FORCE_RETRY](#locerrwininternetforceretry) | |
**Option 317:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CANNOT_CONNECT` | [LOCERR_WIN_INTERNET_CANNOT_CONNECT](#locerrwininternetcannotconnect) | |
**Option 318:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CONNECTION_ABORTED` | [LOCERR_WIN_INTERNET_CONNECTION_ABORTED](#locerrwininternetconnectionaborted) | |
**Option 319:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CONNECTION_RESET` | [LOCERR_WIN_INTERNET_CONNECTION_RESET](#locerrwininternetconnectionreset) | |
**Option 320:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_DISCONNECTED` | [LOCERR_WIN_INTERNET_DISCONNECTED](#locerrwininternetdisconnected) | |
**Option 321:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INCORRECT_FORMAT` | [LOCERR_WIN_INTERNET_INCORRECT_FORMAT](#locerrwininternetincorrectformat) | |
**Option 322:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_CA` | [LOCERR_WIN_INTERNET_INVALID_CA](#locerrwininternetinvalidca) | |
**Option 323:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_OPERATION` | [LOCERR_WIN_INTERNET_INVALID_OPERATION](#locerrwininternetinvalidoperation) | |
**Option 324:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_URL` | [LOCERR_WIN_INTERNET_INVALID_URL](#locerrwininternetinvalidurl) | |
**Option 325:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_ITEM_NOT_FOUND` | [LOCERR_WIN_INTERNET_ITEM_NOT_FOUND](#locerrwininternetitemnotfound) | |
**Option 326:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_LOGIN_FAILURE` | [LOCERR_WIN_INTERNET_LOGIN_FAILURE](#locerrwininternetloginfailure) | |
**Option 327:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED` | [LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED](#locerrwininternetnamenotresolved) | |
**Option 328:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_NEED_UI` | [LOCERR_WIN_INTERNET_NEED_UI](#locerrwininternetneedui) | |
**Option 329:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID` | [LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID](#locerrwininternetseccertcninvalid) | |
**Option 330:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID` | [LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID](#locerrwininternetseccertdateinvalid) | |
**Option 331:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_ERRORS` | [LOCERR_WIN_INTERNET_SEC_CERT_ERRORS](#locerrwininternetseccerterrors) | |
**Option 332:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_INVALID_CERT` | [LOCERR_WIN_INTERNET_SEC_INVALID_CERT](#locerrwininternetsecinvalidcert) | |
**Option 333:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SERVER_UNREACHABLE` | [LOCERR_WIN_INTERNET_SERVER_UNREACHABLE](#locerrwininternetserverunreachable) | |
**Option 334:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BM_RESULT_TOO_LARGE` | [LOCERR_BM_RESULT_TOO_LARGE](#locerrbmresulttoolarge) | |
---
### LOCERR_APP_ALREADY_EXISTS
---
### LOCERR_APP_ALREADY_OPEN
---
### LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE
---
### LOCERR_APP_CONNECT_FAILED
---
### LOCERR_APP_CREATE_FAILED
---
### LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED
---
### LOCERR_APP_EVENT_SOURCE_TIMEOUT
---
### LOCERR_APP_EXPORT_FAILED
---
### LOCERR_APP_IMPORT_FAILED
---
### LOCERR_APP_INVALID
---
### LOCERR_APP_INVALID_NAME
---
### LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE
---
### LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION
---
### LOCERR_APP_MIGRATION_FAILURE
---
### LOCERR_APP_NOT_FOUND
---
### LOCERR_APP_NOT_OPEN
---
### LOCERR_APP_SAVE_FAILED
---
### LOCERR_APP_SCRIPT_MISSING
---
### LOCERR_APP_SIZE_EXCEEDED
---
### LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED
---
### LOCERR_BDI_STATUS_OK
---
### LOCERR_BM_RESULT_TOO_LARGE
---
### LOCERR_CALC_EVAL_CONDITION_FAILED
---
### LOCERR_CALC_HEAP_ERROR
---
### LOCERR_CALC_INVALID_COL_SORT
---
### LOCERR_CALC_INVALID_DEF
---
### LOCERR_CALC_MISSING_LINKED
---
### LOCERR_CALC_MISSING_LINKED_FIELD
---
### LOCERR_CALC_MIXED_LINKED_AGGREGATION
---
### LOCERR_CALC_NOT_CALCULATED
---
### LOCERR_CALC_NOT_IN_LIB
---
### LOCERR_CALC_PAGES_TOO_LARGE
---
### LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS
---
### LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED
---
### LOCERR_CALC_TIMEOUT
---
### LOCERR_CALC_TOO_LARGE
---
### LOCERR_CALC_VALIDATION_STATE_INVALID
---
### LOCERR_CONNECTION_ALREADY_EXISTS
---
### LOCERR_CONNECTION_FAILED_TO_IMPORT
---
### LOCERR_CONNECTION_FAILED_TO_LOAD
---
### LOCERR_CONNECTION_MISSING_CREDENTIALS
---
### LOCERR_CONNECTION_NAME_IS_INVALID
---
### LOCERR_CONNECTION_NOT_FOUND
---
### LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE
---
### LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT
---
### LOCERR_CURL_BAD_CONTENT_ENCODING
---
### LOCERR_CURL_COULDNT_CONNECT
---
### LOCERR_CURL_COULDNT_RESOLVE_PROXY
---
### LOCERR_CURL_FILE_COULDNT_READ_FILE
---
### LOCERR_CURL_FTP_ACCEPT_FAILED
---
### LOCERR_CURL_FTP_ACCEPT_TIMEOUT
---
### LOCERR_CURL_FTP_CANT_GET_HOST
---
### LOCERR_CURL_FTP_COULDNT_USE_REST
---
### LOCERR_CURL_GOT_NOTHING
---
### LOCERR_CURL_HTTP_POST_ERROR
---
### LOCERR_CURL_LDAP_CANNOT_BIND
---
### LOCERR_CURL_LDAP_INVALID_URL
---
### LOCERR_CURL_LDAP_SEARCH_FAILED
---
### LOCERR_CURL_LOGIN_DENIED
---
### LOCERR_CURL_OPERATION_TIMEDOUT
---
### LOCERR_CURL_OUT_OF_MEMORY
---
### LOCERR_CURL_PARTIAL_FILE
---
### LOCERR_CURL_PEER_FAILED_VERIFICATION
---
### LOCERR_CURL_QUOTE_ERROR
---
### LOCERR_CURL_REMOTE_ACCESS_DENIED
---
### LOCERR_CURL_SSH
---
### LOCERR_CURL_SSL_CACERT
---
### LOCERR_CURL_SSL_CERTPROBLEM
---
### LOCERR_CURL_SSL_CIPHER
---
### LOCERR_CURL_SSL_CONNECT_ERROR
---
### LOCERR_CURL_SSL_ENGINE_INITFAILED
---
### LOCERR_CURL_SSL_ENGINE_NOTFOUND
---
### LOCERR_CURL_SSL_ENGINE_SETFAILED
---
### LOCERR_CURL_TFTP_ILLEGAL
---
### LOCERR_CURL_TFTP_NOTFOUND
---
### LOCERR_CURL_TOO_MANY_REDIRECTS
---
### LOCERR_CURL_UNSUPPORTED_PROTOCOL
---
### LOCERR_CURL_UPLOAD_FAILED
---
### LOCERR_CURL_USE_SSL_FAILED
---
### LOCERR_CURL_WRITE_ERROR
---
### LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED
---
### LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED
---
### LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED
---
### LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT
---
### LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL
---
### LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED
---
### LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED
---
### LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED
---
### LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW
---
### LOCERR_EXPORT_NO_DATA
---
### LOCERR_EXPORT_OUT_OF_MEMORY
---
### LOCERR_EXTENGINE_GRPC_STATUS_ABORTED
---
### LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS
---
### LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED
---
### LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS
---
### LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED
---
### LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION
---
### LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL
---
### LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT
---
### LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND
---
### LOCERR_EXTENGINE_GRPC_STATUS_OK
---
### LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE
---
### LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED
---
### LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED
---
### LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED
---
### LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE
---
### LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED
---
### LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN
---
### LOCERR_FEATURE_DISABLED
---
### LOCERR_FILE_ACCESS_DENIED
---
### LOCERR_FILE_CORRUPT
---
### LOCERR_FILE_FORMAT_UNSUPPORTED
---
### LOCERR_FILE_NAME_INVALID
---
### LOCERR_FILE_NOT_FOUND
---
### LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE
---
### LOCERR_FILE_TABLE_NOT_FOUND
---
### LOCERR_GENERIC_ABORTED
---
### LOCERR_GENERIC_ACCESS_DENIED
---
### LOCERR_GENERIC_ALREADY_EXISTS
---
### LOCERR_GENERIC_CONNECTION_LOST
---
### LOCERR_GENERIC_CORRUPT_DATA
---
### LOCERR_GENERIC_EMPTY_PARAMETERS
---
### LOCERR_GENERIC_ENGINE_TERMINATED
---
### LOCERR_GENERIC_INTERNAL_ERROR
---
### LOCERR_GENERIC_INVALID_PARAMETERS
---
### LOCERR_GENERIC_INVALID_PATH
---
### LOCERR_GENERIC_INVISIBLE_OWNER_ABORT
---
### LOCERR_GENERIC_MEMORY_INCONSISTENCY
---
### LOCERR_GENERIC_MEMORY_LIMIT_REACHED
---
### LOCERR_GENERIC_NOT_FOUND
---
### LOCERR_GENERIC_NOT_IMPLEMENTED
---
### LOCERR_GENERIC_NOT_INITIALIZED
---
### LOCERR_GENERIC_NOT_SET
---
### LOCERR_GENERIC_OK
---
### LOCERR_GENERIC_OUT_OF_MEMORY
---
### LOCERR_GENERIC_PROHIBIT_VALIDATE
---
### LOCERR_GENERIC_REST_CONNECTION_FAILURE
---
### LOCERR_GENERIC_UNKNOWN
---
### LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION
---
### LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED
---
### LOCERR_HC_INVALID_OBJECT
---
### LOCERR_HC_INVALID_OBJECT_STATE
---
### LOCERR_HC_MODAL_OBJECT_ERROR
---
### LOCERR_HC_RESULT_TOO_LARGE
---
### LOCERR_HTTP_400
---
### LOCERR_HTTP_401
---
### LOCERR_HTTP_402
---
### LOCERR_HTTP_403
---
### LOCERR_HTTP_404
---
### LOCERR_HTTP_405
---
### LOCERR_HTTP_406
---
### LOCERR_HTTP_407
---
### LOCERR_HTTP_408
---
### LOCERR_HTTP_409
---
### LOCERR_HTTP_410
---
### LOCERR_HTTP_411
---
### LOCERR_HTTP_412
---
### LOCERR_HTTP_413
---
### LOCERR_HTTP_414
---
### LOCERR_HTTP_415
---
### LOCERR_HTTP_416
---
### LOCERR_HTTP_417
---
### LOCERR_HTTP_422
---
### LOCERR_HTTP_423
---
### LOCERR_HTTP_429
---
### LOCERR_HTTP_500
---
### LOCERR_HTTP_501
---
### LOCERR_HTTP_502
---
### LOCERR_HTTP_503
---
### LOCERR_HTTP_504
---
### LOCERR_HTTP_505
---
### LOCERR_HTTP_509
---
### LOCERR_HTTP_COULD_NOT_RESOLVE_HOST
---
### LOCERR_INTERNAL_ERROR
---
### LOCERR_JSON_RPC_INTERNAL_ERROR
---
### LOCERR_JSON_RPC_INVALID_PARAMETERS
---
### LOCERR_JSON_RPC_INVALID_REQUEST
---
### LOCERR_JSON_RPC_METHOD_NOT_FOUND
---
### LOCERR_JSON_RPC_PARSE_ERROR
---
### LOCERR_JSON_RPC_RESPONSE_TOO_LARGE
---
### LOCERR_LAYOUT_EXTENDS_INVALID_ID
---
### LOCERR_LAYOUT_LINKED_OBJECT_INVALID
---
### LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND
---
### LOCERR_LOAD_TOO_MANY_FIELDS
---
### LOCERR_LOAD_TOO_MANY_TABLES
---
### LOCERR_LXW_ERROR
---
### LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED
---
### LOCERR_LXW_ERROR_CREATING_TMPFILE
---
### LOCERR_LXW_ERROR_CREATING_XLSX_FILE
---
### LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED
---
### LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED
---
### LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED
---
### LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND
---
### LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE
---
### LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED
---
### LOCERR_LXW_ERROR_ZIP_CLOSE
---
### LOCERR_LXW_ERROR_ZIP_FILE_ADD
---
### LOCERR_LXW_ERROR_ZIP_FILE_OPERATION
---
### LOCERR_LXW_INVALID_EXPORT_RANGE
---
### LOCERR_LXW_INVALID_FILE
---
### LOCERR_LXW_INVALID_OBJ
---
### LOCERR_LXW_INVALID_SHEET
---
### LOCERR_MEDIA_BUNDLING_FAILED
---
### LOCERR_MEDIA_LIBRARY_CONTENT_FAILED
---
### LOCERR_MEDIA_LIBRARY_LIST_FAILED
---
### LOCERR_MEDIA_LIBRARY_NOT_FOUND
---
### LOCERR_MEDIA_UNBUNDLING_FAILED
---
### LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED
---
### LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED
---
### LOCERR_MQ_PROTOCOL_INVALID_STATUS
---
### LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION
---
### LOCERR_MQ_PROTOCOL_NO_RESPONE
---
### LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR
---
### LOCERR_MQ_SOCKET_CONNECT_FAILURE
---
### LOCERR_MQ_SOCKET_OPEN_FAILURE
---
### LOCERR_PERSISTENCE_DELETE_FAILED
---
### LOCERR_PERSISTENCE_DISK_FULL
---
### LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING
---
### LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED
---
### LOCERR_PERSISTENCE_MIGRATION_CANCELLED
---
### LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY
---
### LOCERR_PERSISTENCE_MOVE_FAILED
---
### LOCERR_PERSISTENCE_NOT_FOUND
---
### LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP
---
### LOCERR_PERSISTENCE_OBJECT_LOCKED
---
### LOCERR_PERSISTENCE_READ_FAILED
---
### LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS
---
### LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS
---
### LOCERR_PERSISTENCE_UNSUPPORTED_VERSION
---
### LOCERR_PERSISTENCE_WRITE_FAILED
---
### LOCERR_PERSONAL_APP_DELETION_FAILED
---
### LOCERR_PERSONAL_NEW_VERSION_AVAILABLE
---
### LOCERR_PERSONAL_SECTION_ACCESS_DETECTED
---
### LOCERR_PERSONAL_VERSION_EXPIRED
---
### LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT
---
### LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY
---
### LOCERR_RELOAD_AUTO_GENERATE_COUNT
---
### LOCERR_RELOAD_BINARY_LOAD_PROHIBITED
---
### LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE
---
### LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR
---
### LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR
---
### LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING
---
### LOCERR_RELOAD_CONNECTOR_REPLY_ERROR
---
### LOCERR_RELOAD_CONNECTOR_START_FAILED
---
### LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE
---
### LOCERR_RELOAD_CUSTOM_CONNECT_FAILED
---
### LOCERR_RELOAD_CUSTOM_READ_FAILED
---
### LOCERR_RELOAD_EXIT_ERROR
---
### LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN
---
### LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN
---
### LOCERR_RELOAD_FIELD_X_NOT_FOUND
---
### LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS
---
### LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS
---
### LOCERR_RELOAD_IN_PROGRESS
---
### LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND
---
### LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND
---
### LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR
---
### LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID
---
### LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND
---
### LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE
---
### LOCERR_RELOAD_MERGE_LOAD_ERROR
---
### LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS
---
### LOCERR_RELOAD_NAME_ALREADY_TAKEN
---
### LOCERR_RELOAD_NO_OPEN_DATABASE
---
### LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE
---
### LOCERR_RELOAD_ODBC_CONNECT_FAILED
---
### LOCERR_RELOAD_ODBC_READ_FAILED
---
### LOCERR_RELOAD_OLEDB_CONNECT_FAILED
---
### LOCERR_RELOAD_OLEDB_READ_FAILED
---
### LOCERR_RELOAD_OPEN_FILE_ERROR
---
### LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB
---
### LOCERR_RELOAD_TABLE_X_NOT_FOUND
---
### LOCERR_RELOAD_UNKNOWN_STATEMENT
---
### LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF
---
### LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF
---
### LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED
---
### LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD
---
### LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED
---
### LOCERR_SEARCH_TIMEOUT
---
### LOCERR_SERVER_AJAX_DISABLED
---
### LOCERR_SERVER_BUSY
---
### LOCERR_SERVER_LICENSE_EXPIRED
---
### LOCERR_SERVER_NO_TOKEN
---
### LOCERR_SERVER_OFF_DUTY
---
### LOCERR_SERVER_OUT_OF_CALS
---
### LOCERR_SERVER_OUT_OF_NAMED_CALS
---
### LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS
---
### LOCERR_SERVER_OUT_OF_SESSION_CALS
---
### LOCERR_SERVER_OUT_OF_USAGE_CALS
---
### LOCERR_SETEXPRESSION_TOO_LARGE
---
### LOCERR_SMART_LOAD_TABLE_DUPLICATED
---
### LOCERR_SMART_LOAD_TABLE_NOT_FOUND
---
### LOCERR_SYNC_INVALID_OFFSET
---
### LOCERR_TRENDLINE_INVALID_DEF
---
### LOCERR_TRENDLINE_INVALID_MATH_ERROR
---
### LOCERR_USER_ACCESS_DENIED
---
### LOCERR_USER_AUTHENTICATION_FAILURE
---
### LOCERR_USER_IMPERSONATION_FAILED
---
### LOCERR_VARIABLE_CONSTRAINT_FAILED
---
### LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY
---
### LOCERR_VARIABLE_DUPLICATE_NAME
---
### LOCERR_VARIABLE_INCONSISTENCY
---
### LOCERR_VARIABLE_NO_NAME
---
### LOCERR_WIN_FTP_DROPPED
---
### LOCERR_WIN_FTP_NO_PASSIVE_MODE
---
### LOCERR_WIN_HTTP_DOWNLEVEL_SERVER
---
### LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE
---
### LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION
---
### LOCERR_WIN_INTERNET_CANNOT_CONNECT
---
### LOCERR_WIN_INTERNET_CONNECTION_ABORTED
---
### LOCERR_WIN_INTERNET_CONNECTION_RESET
---
### LOCERR_WIN_INTERNET_DISCONNECTED
---
### LOCERR_WIN_INTERNET_FORCE_RETRY
---
### LOCERR_WIN_INTERNET_INCORRECT_FORMAT
---
### LOCERR_WIN_INTERNET_INVALID_CA
---
### LOCERR_WIN_INTERNET_INVALID_OPERATION
---
### LOCERR_WIN_INTERNET_INVALID_URL
---
### LOCERR_WIN_INTERNET_ITEM_NOT_FOUND
---
### LOCERR_WIN_INTERNET_LOGIN_FAILURE
---
### LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED
---
### LOCERR_WIN_INTERNET_NEED_UI
---
### LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID
---
### LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID
---
### LOCERR_WIN_INTERNET_SEC_CERT_ERRORS
---
### LOCERR_WIN_INTERNET_SEC_INVALID_CERT
---
### LOCERR_WIN_INTERNET_SERVER_UNREACHABLE
---
## Schemas
### AlfaNumString
| Name | Type | Description |
| --- | --- | --- |
| `qString` | `string` | Calculated value. |
| `qIsNum` | `boolean` | Is set to true if the value is a numeric. |
---
### AlternateStateData
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections: $ |
| `qFieldItems` | `array` of [BookmarkFieldItem](#bookmarkfielditem) | List of the selections. |
Properties of `qFieldItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkFieldItem` | [BookmarkFieldItem](#bookmarkfielditem) | |
Properties of `BookmarkFieldItem`
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | [FieldDefEx](#fielddefex) | |
| `qLocked` | `boolean` | Indicates if the field is locked. Default is false. |
| `qSelectInfo` | [SelectInfo](#selectinfo) | |
| `qValues` | `array` of [FieldValue](#fieldvalue) | |
| `qExcludedValues` | `array` of [FieldValue](#fieldvalue) | List of excluded values. Either the list of selected values or the list of excluded values is displayed. |
| `qAndMode` | `boolean` | If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 **and** Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 **or** Customer 2 are selected. This parameter is not returned if set to false. |
| `qOneAndOnlyOne` | `boolean` | If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false. |
| `qValuesCount` | `integer` | Count of selected values. Indicates if the Values field is loaded. |
| `qExcludedValuesCount` | `integer` | Count of excluded values. Indicates if the ExcludedValues field is loaded. |
Properties of `qDef`
_Properties truncated due to depth limit._
Properties of `qSelectInfo`
_Properties truncated due to depth limit._
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qExcludedValues`
**Array items:**
_Properties truncated due to depth limit._
---
### AppEntry
| Name | Type | Description |
| --- | --- | --- |
| `qID` | `string` | Identifier of the app. |
| `qTitle` | `string` | Title of the app. |
| `qPath` | `string` | Path of the app. |
| `qLastReloadTime` | `string` | Last reload time of the app. |
| `qReadOnly` | `boolean` | Is set to true if the app is read-only. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qThumbnail` | [StaticContentUrl](#staticcontenturl) | In addition, this structure can return dynamic properties.
|
| `qFileSize` | `integer` | |
| `qHasSectionAccess` | `boolean` | If true the app has section access configured. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qThumbnail`
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
---
### AppObjectList
Lists the app objects. Is the layout for _AppObjectListDef_.
An app object is a generic object created at app level.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxContainerEntry](#nxcontainerentry) | Information about the list of dimensions. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxContainerEntry` | [NxContainerEntry](#nxcontainerentry) | |
Properties of `NxContainerEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qMeta`
_Properties truncated due to depth limit._
---
### AppObjectListDef
Defines the list of objects in an app.
An app object is a generic object created at app level.
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | Type of the app list. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
---
### AppScript
| Name | Type | Description |
| --- | --- | --- |
| `qScript` | `string` | Script text. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qIsLocked` | `boolean` | True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### AppScriptMeta
| Name | Type | Description |
| --- | --- | --- |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qIsLocked` | `boolean` | True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### ApplyGroupStateWarning
| Name | Type | Description |
| --- | --- | --- |
| `qState` | [GroupState](#groupstate) | |
| `qType` | oneOf(group_missing \| group_not_applicable \| fielddef_missing) | |
Properties of `qState`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qActiveFieldDef` | `string` | String defining the active field. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `group_missing` | `object` | GROUP_MISSING |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `group_not_applicable` | `object` | GROUP_NOT_APPLICABLE |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `fielddef_missing` | `object` | FIELDDEF_MISSING |
---
### ApplyGroupStateWarningType
| Name | Type | Description |
| --- | --- | --- |
| `ApplyGroupStateWarningType` | oneOf(group_missing \| group_not_applicable \| fielddef_missing) | |
Properties of `ApplyGroupStateWarningType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `group_missing` | `object` | GROUP_MISSING |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `group_not_applicable` | `object` | GROUP_NOT_APPLICABLE |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `fielddef_missing` | `object` | FIELDDEF_MISSING |
---
### ApplyGroupStatesResult
Result of applying GroupState to multiple cyclic groups.
| Name | Type | Description |
| --- | --- | --- |
| `qApplySuccess` | `boolean` | When true, the operation was successful. |
| `qWarnings` | `array` of [ApplyGroupStateWarning](#applygroupstatewarning) | Lists which states failed to be applied and why. |
Properties of `qWarnings`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ApplyGroupStateWarning` | [ApplyGroupStateWarning](#applygroupstatewarning) | |
Properties of `ApplyGroupStateWarning`
| Name | Type | Description |
| --- | --- | --- |
| `qState` | [GroupState](#groupstate) | |
| `qType` | oneOf(group_missing \| group_not_applicable \| fielddef_missing) | |
Properties of `qState`
_Properties truncated due to depth limit._
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
---
### ArrayOfNxValuePoint
| Name | Type | Description |
| --- | --- | --- |
| `ArrayOfNxValuePoint` | `array` of [NxPivotValuePoint](#nxpivotvaluepoint) | |
Properties of `ArrayOfNxValuePoint`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPivotValuePoint` | [NxPivotValuePoint](#nxpivotvaluepoint) | |
Properties of `NxPivotValuePoint`
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | Label of the cell. This parameter is optional. |
| `qText` | `string` | Some text related to the cell. |
| `qNum` | `number` | Value of the cell. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
---
### AssociationScore
| Name | Type | Description |
| --- | --- | --- |
| `qFieldPairName` | `string` | Pair of fields. _< FieldName1>_ / _< FieldName2>_ Where: < _FieldName1_ > is a field in the table 1 (defined in _qTable1_ ) < _FieldName2_ > is a field in the table 2 (defined in _qTable2_ ) If the field is a synthetic key, the name of the field is preceded by _[Synthetic key]:_ . |
| `qScoreSummary` | `integer` | Flag used to interpret calculated scores. One of the following values or sum of values that apply: * 0: The cardinal ratio cannot be zero but the symbol score and the row score can be zero. * -1: The fields do not have the same type. * -2: The number of rows of the field _FieldName1_ is zero. * -4: The number of distinct values of the field _FieldName1_ is zero. * -8: The number of rows of the field _FieldName2_ is zero. * -16: The number of distinct values of the field _FieldName2_ is zero. Example: The number of rows of the field _FieldName1_ is zero, and the number of distinct values of the field _FieldName2_ is zero, then _qScoreSummary_ is -18. |
| `qField1Scores` | [FieldScores](#fieldscores) | |
| `qField2Scores` | [FieldScores](#fieldscores) | |
Properties of `qField1Scores`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | Field name. One of the field names defined in _qFieldPairName._ |
| `qReadableName` | `string` | |
| `qCardinalRatio` | `number` | Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key. |
| `qSymbolScore` | `number` | Number of distinct matches between the two fields defined in _qFieldPairName_ divided by the number of distinct values in the field _qFieldName_ . If 0, it means that there are no common values between the two fields defined in _qFieldPairName_ . |
| `qRowScore` | `number` | Number of matches between the two fields defined in _qFieldPairName_ divided by the number of values in the field _qFieldName_ . If 0, it means that there are no common values between the two fields defined in _qFieldPairName_ . |
Properties of `qField2Scores`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | Field name. One of the field names defined in _qFieldPairName._ |
| `qReadableName` | `string` | |
| `qCardinalRatio` | `number` | Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key. |
| `qSymbolScore` | `number` | Number of distinct matches between the two fields defined in _qFieldPairName_ divided by the number of distinct values in the field _qFieldName_ . If 0, it means that there are no common values between the two fields defined in _qFieldPairName_ . |
| `qRowScore` | `number` | Number of matches between the two fields defined in _qFieldPairName_ divided by the number of values in the field _qFieldName_ . If 0, it means that there are no common values between the two fields defined in _qFieldPairName_ . |
---
### BNFDef
| Name | Type | Description |
| --- | --- | --- |
| `qBnf` | `array of integer` | Array of token references that all together build up the definition of the current token. Generally, if the array is not empty, the definition is a BNF rule (_qIsBnfRule_ is set to true). However, some BNF rules do have an empty array (_qIsBnfRule_ is set to true, but _qBnf_ is empty). |
| `qNbr` | `integer` | Number of the current token definition. |
| `qPNbr` | `integer` | Number of the parent rule definition. |
| `qHelpId` | `integer` | Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name. Is not used in Qlik Sense. |
| `qName` | `string` | Token name. One of: * A rule name * An identifier * A literal value |
| `qStr` | `string` | Literal string of the token. Examples: 'Round' and '('. |
| `qIsBnfRule` | `boolean` | If set to true, a list of related rule tokens is assigned to _qBnf_ . This parameter is optional. The default value is false. |
| `qScriptStatement` | `boolean` | If set to true, the definition specifies a script statement. This parameter is optional. The default value is false. |
| `qControlStatement` | `boolean` | If set to true, the definition specifies a control statement. This parameter is optional. The default value is false. |
| `qBnfLiteral` | `boolean` | If set to true, the definition specifies a literal token. This parameter is optional. The default value is false. |
| `qQvFunc` | `boolean` | If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function. This parameter is optional. The default value is false. |
| `qAggrFunc` | `boolean` | If set to true, the definition is related to an aggregation function. This parameter is optional. The default value is false. |
| `qFG` | oneOf(ALL \| U \| NONE \| AGGR \| NUM \| RNG \| EXP \| TRIG \| FIN \| MATH \| COUNT \| STR \| MAPP \| RCRD \| CND \| LOG \| NULL \| SYS \| FILE \| TBL \| DATE \| NUMI \| FRMT \| CLR \| RNK \| GEO \| EXT \| PROB \| ARRAY \| LEG \| DB \| WINDOW) | |
| `qFieldFlag` | `boolean` | If set to true, the definition is related to a field. This parameter is optional. The default value is false. |
| `qMT` | oneOf(N \| D \| R \| V) | |
| `qDepr` | `boolean` | Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use). If set to true, the script statement or the function is not recommended for use in Qlik Sense. This parameter is optional. The default value is false. |
| `qFGList` | `array` of [FunctionGroup](#functiongroup) | List of groups the function belongs to. |
Properties of `qBnf`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qFG`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ALL` | `object` | FUNC_GROUP_ALL |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | FUNC_GROUP_UNKNOWN |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `NONE` | `object` | FUNC_GROUP_NONE |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `AGGR` | `object` | FUNC_GROUP_AGGR |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `NUM` | `object` | FUNC_GROUP_NUMERIC |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `RNG` | `object` | FUNC_GROUP_RANGE |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `EXP` | `object` | FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `TRIG` | `object` | FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `FIN` | `object` | FUNC_GROUP_FINANCIAL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `MATH` | `object` | FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `COUNT` | `object` | FUNC_GROUP_COUNTER |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `STR` | `object` | FUNC_GROUP_STRING |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `MAPP` | `object` | FUNC_GROUP_MAPPING |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `RCRD` | `object` | FUNC_GROUP_INTER_RECORD |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `CND` | `object` | FUNC_GROUP_CONDITIONAL |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG` | `object` | FUNC_GROUP_LOGICAL |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `NULL` | `object` | FUNC_GROUP_NULL |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `SYS` | `object` | FUNC_GROUP_SYSTEM |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `FILE` | `object` | FUNC_GROUP_FILE |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `TBL` | `object` | FUNC_GROUP_TABLE |
**Option 21:**
| Name | Type | Description |
| --- | --- | --- |
| `DATE` | `object` | FUNC_GROUP_DATE_AND_TIME |
**Option 22:**
| Name | Type | Description |
| --- | --- | --- |
| `NUMI` | `object` | FUNC_GROUP_NUMBER_INTERPRET |
**Option 23:**
| Name | Type | Description |
| --- | --- | --- |
| `FRMT` | `object` | FUNC_GROUP_FORMATTING |
**Option 24:**
| Name | Type | Description |
| --- | --- | --- |
| `CLR` | `object` | FUNC_GROUP_COLOR |
**Option 25:**
| Name | Type | Description |
| --- | --- | --- |
| `RNK` | `object` | FUNC_GROUP_RANKING |
**Option 26:**
| Name | Type | Description |
| --- | --- | --- |
| `GEO` | `object` | FUNC_GROUP_GEO |
**Option 27:**
| Name | Type | Description |
| --- | --- | --- |
| `EXT` | `object` | FUNC_GROUP_EXTERNAL |
**Option 28:**
| Name | Type | Description |
| --- | --- | --- |
| `PROB` | `object` | FUNC_GROUP_PROBABILITY |
**Option 29:**
| Name | Type | Description |
| --- | --- | --- |
| `ARRAY` | `object` | FUNC_GROUP_ARRAY |
**Option 30:**
| Name | Type | Description |
| --- | --- | --- |
| `LEG` | `object` | FUNC_GROUP_LEGACY |
**Option 31:**
| Name | Type | Description |
| --- | --- | --- |
| `DB` | `object` | FUNC_GROUP_DB_NATIVE |
**Option 32:**
| Name | Type | Description |
| --- | --- | --- |
| `WINDOW` | `object` | FUNC_GROUP_WINDOW |
Properties of `qMT`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NOT_META |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | META_DOC_NAME |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | META_RET_TYPE |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | META_DEFAULT_VALUE |
Properties of `qFGList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FunctionGroup` | oneOf(ALL \| U \| NONE \| AGGR \| NUM \| RNG \| EXP \| TRIG \| FIN \| MATH \| COUNT \| STR \| MAPP \| RCRD \| CND \| LOG \| NULL \| SYS \| FILE \| TBL \| DATE \| NUMI \| FRMT \| CLR \| RNK \| GEO \| EXT \| PROB \| ARRAY \| LEG \| DB \| WINDOW) | |
Properties of `FunctionGroup`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ALL` | `object` | FUNC_GROUP_ALL |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | FUNC_GROUP_UNKNOWN |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `NONE` | `object` | FUNC_GROUP_NONE |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `AGGR` | `object` | FUNC_GROUP_AGGR |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `NUM` | `object` | FUNC_GROUP_NUMERIC |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `RNG` | `object` | FUNC_GROUP_RANGE |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `EXP` | `object` | FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `TRIG` | `object` | FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `FIN` | `object` | FUNC_GROUP_FINANCIAL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `MATH` | `object` | FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `COUNT` | `object` | FUNC_GROUP_COUNTER |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `STR` | `object` | FUNC_GROUP_STRING |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `MAPP` | `object` | FUNC_GROUP_MAPPING |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `RCRD` | `object` | FUNC_GROUP_INTER_RECORD |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `CND` | `object` | FUNC_GROUP_CONDITIONAL |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG` | `object` | FUNC_GROUP_LOGICAL |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `NULL` | `object` | FUNC_GROUP_NULL |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `SYS` | `object` | FUNC_GROUP_SYSTEM |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `FILE` | `object` | FUNC_GROUP_FILE |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `TBL` | `object` | FUNC_GROUP_TABLE |
**Option 21:**
| Name | Type | Description |
| --- | --- | --- |
| `DATE` | `object` | FUNC_GROUP_DATE_AND_TIME |
**Option 22:**
| Name | Type | Description |
| --- | --- | --- |
| `NUMI` | `object` | FUNC_GROUP_NUMBER_INTERPRET |
**Option 23:**
| Name | Type | Description |
| --- | --- | --- |
| `FRMT` | `object` | FUNC_GROUP_FORMATTING |
**Option 24:**
| Name | Type | Description |
| --- | --- | --- |
| `CLR` | `object` | FUNC_GROUP_COLOR |
**Option 25:**
| Name | Type | Description |
| --- | --- | --- |
| `RNK` | `object` | FUNC_GROUP_RANKING |
**Option 26:**
| Name | Type | Description |
| --- | --- | --- |
| `GEO` | `object` | FUNC_GROUP_GEO |
**Option 27:**
| Name | Type | Description |
| --- | --- | --- |
| `EXT` | `object` | FUNC_GROUP_EXTERNAL |
**Option 28:**
| Name | Type | Description |
| --- | --- | --- |
| `PROB` | `object` | FUNC_GROUP_PROBABILITY |
**Option 29:**
| Name | Type | Description |
| --- | --- | --- |
| `ARRAY` | `object` | FUNC_GROUP_ARRAY |
**Option 30:**
| Name | Type | Description |
| --- | --- | --- |
| `LEG` | `object` | FUNC_GROUP_LEGACY |
**Option 31:**
| Name | Type | Description |
| --- | --- | --- |
| `DB` | `object` | FUNC_GROUP_DB_NATIVE |
**Option 32:**
| Name | Type | Description |
| --- | --- | --- |
| `WINDOW` | `object` | FUNC_GROUP_WINDOW |
---
### BNFDefMetaType
| Name | Type | Description |
| --- | --- | --- |
| `BNFDefMetaType` | oneOf(N \| D \| R \| V) | |
Properties of `BNFDefMetaType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NOT_META |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | META_DOC_NAME |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | META_RET_TYPE |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | META_DEFAULT_VALUE |
---
### BNFType
| Name | Type | Description |
| --- | --- | --- |
| `BNFType` | oneOf(S \| E) | |
Properties of `BNFType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | SCRIPT_TEXT_SCRIPT |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `E` | `object` | SCRIPT_TEXT_EXPRESSION |
---
### Blob
---
### Bookmark
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qName` | `string` | |
| `qUtcModifyTime` | `number` | |
| `qUtcRecallTime` | `number` | |
| `qRecallCount` | `integer` | |
| `qApplyAdditive` | `boolean` | |
| `qFieldItems` | `array` of [BookmarkFieldItem](#bookmarkfielditem) | |
| `qVariableItems` | `array` of [BookmarkVariableItem](#bookmarkvariableitem) | |
| `qSheetId` | `string` | |
| `qObjects` | `array` of [LayoutBookmarkData](#layoutbookmarkdata) | |
| `qApplyLayoutState` | `boolean` | |
| `qShowPopupInfo` | `boolean` | |
| `qInfoText` | `string` | |
| `qOwner` | `string` | |
| `qGroups` | `array` of [GroupBookmarkData](#groupbookmarkdata) | |
| `qShow` | [CondDef](#conddef) | |
| `qApplyInputFieldValues` | `boolean` | |
| `qInputFieldItems` | `array` of [InputFieldItem](#inputfielditem) | |
| `qObjectsLayout` | `array` of [ExtendedLayoutBookmarkData](#extendedlayoutbookmarkdata) | |
| `qIncludeSelectionState` | `boolean` | |
| `qIncludeScrollPosition` | `boolean` | |
| `qAlternateStateData` | `array` of [AlternateStateData](#alternatestatedata) | |
| `qForAnnotations` | `boolean` | |
| `qIncludeAllVariables` | `boolean` | |
Properties of `qFieldItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkFieldItem` | [BookmarkFieldItem](#bookmarkfielditem) | |
Properties of `BookmarkFieldItem`
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | [FieldDefEx](#fielddefex) | |
| `qLocked` | `boolean` | Indicates if the field is locked. Default is false. |
| `qSelectInfo` | [SelectInfo](#selectinfo) | |
| `qValues` | `array` of [FieldValue](#fieldvalue) | |
| `qExcludedValues` | `array` of [FieldValue](#fieldvalue) | List of excluded values. Either the list of selected values or the list of excluded values is displayed. |
| `qAndMode` | `boolean` | If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 **and** Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 **or** Customer 2 are selected. This parameter is not returned if set to false. |
| `qOneAndOnlyOne` | `boolean` | If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false. |
| `qValuesCount` | `integer` | Count of selected values. Indicates if the Values field is loaded. |
| `qExcludedValuesCount` | `integer` | Count of excluded values. Indicates if the ExcludedValues field is loaded. |
Properties of `qDef`
_Properties truncated due to depth limit._
Properties of `qSelectInfo`
_Properties truncated due to depth limit._
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qExcludedValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qVariableItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkVariableItem` | [BookmarkVariableItem](#bookmarkvariableitem) | |
Properties of `BookmarkVariableItem`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the variable. |
| `qValue` | [FieldValue](#fieldvalue) | |
| `qDefinition` | `string` | The Reporting mode definition of the variable. |
Properties of `qValue`
_Properties truncated due to depth limit._
Properties of `qObjects`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `LayoutBookmarkData` | [LayoutBookmarkData](#layoutbookmarkdata) | |
Properties of `LayoutBookmarkData`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qActive` | `boolean` | |
| `qShowMode` | `integer` | |
| `qScrollPos` | [ScrollPosition](#scrollposition) | |
Properties of `qScrollPos`
_Properties truncated due to depth limit._
Properties of `qGroups`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GroupBookmarkData` | [GroupBookmarkData](#groupbookmarkdata) | |
Properties of `GroupBookmarkData`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qCyclePos` | `integer` | |
Properties of `qShow`
| Name | Type | Description |
| --- | --- | --- |
| `qAlways` | `boolean` | |
| `qExpression` | [ValueExpr](#valueexpr) | |
Properties of `qExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qInputFieldItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `InputFieldItem` | [InputFieldItem](#inputfielditem) | |
Properties of `InputFieldItem`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | |
| `qValues` | `array` of [FieldValue](#fieldvalue) | |
| `qPackedHashKeys` | `array of integer` | |
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qPackedHashKeys`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qObjectsLayout`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ExtendedLayoutBookmarkData` | [ExtendedLayoutBookmarkData](#extendedlayoutbookmarkdata) | |
Properties of `ExtendedLayoutBookmarkData`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qActive` | `boolean` | |
| `qShowMode` | `integer` | |
| `qScrollPos` | [ScrollPosition](#scrollposition) | |
| `qExpansionInfo` | `array` of [ExpansionData](#expansiondata) | |
| `qLeftCollapsed` | `boolean` | |
| `qTopCollapsed` | `boolean` | |
| `qSortData` | `array` of [InterFieldSortData](#interfieldsortdata) | |
| `qDimensionGroupPos` | `array` of [GroupStateInfo](#groupstateinfo) | |
| `qExpressionGroupPos` | `array` of [GroupStateInfo](#groupstateinfo) | |
| `qUseGraphMode` | `boolean` | |
| `qGraphMode` | oneOf(GRAPH_MODE_BAR \| GRAPH_MODE_PIE \| GRAPH_MODE_PIVOTTABLE \| GRAPH_MODE_SCATTER \| GRAPH_MODE_LINE \| GRAPH_MODE_STRAIGHTTABLE \| GRAPH_MODE_COMBO \| GRAPH_MODE_RADAR \| GRAPH_MODE_GAUGE \| GRAPH_MODE_GRID \| GRAPH_MODE_BLOCK \| GRAPH_MODE_FUNNEL \| GRAPH_MODE_MEKKO \| GRAPH_MODE_LAST) | |
| `qActiveContainerChildObjectId` | `string` | |
| `qExtendedPivotState` | [ExtendedPivotStateData](#extendedpivotstatedata) | |
Properties of `qScrollPos`
_Properties truncated due to depth limit._
Properties of `qExpansionInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qSortData`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qDimensionGroupPos`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qExpressionGroupPos`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qGraphMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
**Option 11:**
_Properties truncated due to depth limit._
**Option 12:**
_Properties truncated due to depth limit._
**Option 13:**
_Properties truncated due to depth limit._
**Option 14:**
_Properties truncated due to depth limit._
Properties of `qExtendedPivotState`
_Properties truncated due to depth limit._
Properties of `qAlternateStateData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `AlternateStateData` | [AlternateStateData](#alternatestatedata) | |
Properties of `AlternateStateData`
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections: $ |
| `qFieldItems` | `array` of [BookmarkFieldItem](#bookmarkfielditem) | List of the selections. |
Properties of `qFieldItems`
**Array items:**
_Properties truncated due to depth limit._
---
### BookmarkApplyAndVerifyResult
| Name | Type | Description |
| --- | --- | --- |
| `qApplySuccess` | `boolean` | Apply successfully or not * |
| `qWarnings` | `array` of [BookmarkFieldVerifyWarning](#bookmarkfieldverifywarning) | Field values verfication result * |
| `qGroupStateResult` | [ApplyGroupStatesResult](#applygroupstatesresult) | Result of applying GroupState to multiple cyclic groups. |
Properties of `qWarnings`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkFieldVerifyWarning` | [BookmarkFieldVerifyWarning](#bookmarkfieldverifywarning) | |
Properties of `BookmarkFieldVerifyWarning`
| Name | Type | Description |
| --- | --- | --- |
| `qState` | `string` | Alternate State * |
| `qField` | `string` | Field Name * |
| `qVerifyResult` | oneOf(NOT_VERIFIED \| FIELD_VALUE_MATCH_ALL \| FIELD_MISSING \| FIELD_VALUE_MISSING \| STATE_MISSING) | |
| `qMissingValues` | `array of string` | |
Properties of `qVerifyResult`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
Properties of `qMissingValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qGroupStateResult`
| Name | Type | Description |
| --- | --- | --- |
| `qApplySuccess` | `boolean` | When true, the operation was successful. |
| `qWarnings` | `array` of [ApplyGroupStateWarning](#applygroupstatewarning) | Lists which states failed to be applied and why. |
Properties of `qWarnings`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ApplyGroupStateWarning` | [ApplyGroupStateWarning](#applygroupstatewarning) | |
Properties of `ApplyGroupStateWarning`
_Properties truncated due to depth limit._
---
### BookmarkFieldItem
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | [FieldDefEx](#fielddefex) | |
| `qLocked` | `boolean` | Indicates if the field is locked. Default is false. |
| `qSelectInfo` | [SelectInfo](#selectinfo) | |
| `qValues` | `array` of [FieldValue](#fieldvalue) | |
| `qExcludedValues` | `array` of [FieldValue](#fieldvalue) | List of excluded values. Either the list of selected values or the list of excluded values is displayed. |
| `qAndMode` | `boolean` | If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 **and** Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 **or** Customer 2 are selected. This parameter is not returned if set to false. |
| `qOneAndOnlyOne` | `boolean` | If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false. |
| `qValuesCount` | `integer` | Count of selected values. Indicates if the Values field is loaded. |
| `qExcludedValuesCount` | `integer` | Count of excluded values. Indicates if the ExcludedValues field is loaded. |
Properties of `qDef`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qType` | oneOf(NOT_PRESENT \| PRESENT \| IS_CYCLIC_GROUP \| IS_DRILL_GROUP \| IS_VAR \| IS_EXPR \| IS_IMPLICIT \| IS_DETAIL) | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT_PRESENT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `PRESENT` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_CYCLIC_GROUP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_DRILL_GROUP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_VAR` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_EXPR` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_IMPLICIT` | `object` | |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_DETAIL` | `object` | |
Properties of `qSelectInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qTextSearch` | `string` | Text search string. Everything that matches the text is selected. This parameter is optional. |
| `qRangeLo` | `number` | Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null. |
| `qRangeHi` | `number` | Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null. |
| `qNumberFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qRangeInfo` | `array` of [RangeSelectInfo](#rangeselectinfo) | This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections. |
| `qSoftLock` | `boolean` | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
| `qContinuousRangeInfo` | `array` of [Range](#range) | List of information about ranges for selections. |
| `qSelectFieldSearch` | `boolean` | This parameter is true if the TextSearch is a result of a Select Field operation. |
Properties of `qNumberFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qRangeInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `RangeSelectInfo` | [RangeSelectInfo](#rangeselectinfo) | |
Properties of `RangeSelectInfo`
_Properties truncated due to depth limit._
Properties of `qContinuousRangeInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `Range` | [Range](#range) | |
Properties of `Range`
_Properties truncated due to depth limit._
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldValue` | [FieldValue](#fieldvalue) | |
Properties of `FieldValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
Properties of `qExcludedValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldValue` | [FieldValue](#fieldvalue) | |
Properties of `FieldValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
---
### BookmarkFieldPage
Defines the range of the bookmark fields that are returned.
| Name | Type | Description |
| --- | --- | --- |
| `qStartIndex` | `integer` | The start value of the range. |
| `qEndIndex` | `integer` | The end value of the range. |
---
### BookmarkFieldPageEx
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | The name of the selected state. |
| `qStartIndex` | `integer` | The start value of the range. |
| `qEndIndex` | `integer` | The end value of the range. |
---
### BookmarkFieldVerifyResultState
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkFieldVerifyResultState` | oneOf(NOT_VERIFIED \| FIELD_VALUE_MATCH_ALL \| FIELD_MISSING \| FIELD_VALUE_MISSING \| STATE_MISSING) | |
Properties of `BookmarkFieldVerifyResultState`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT_VERIFIED` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FIELD_VALUE_MATCH_ALL` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `FIELD_MISSING` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `FIELD_VALUE_MISSING` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `STATE_MISSING` | `object` | |
---
### BookmarkFieldVerifyWarning
| Name | Type | Description |
| --- | --- | --- |
| `qState` | `string` | Alternate State * |
| `qField` | `string` | Field Name * |
| `qVerifyResult` | oneOf(NOT_VERIFIED \| FIELD_VALUE_MATCH_ALL \| FIELD_MISSING \| FIELD_VALUE_MISSING \| STATE_MISSING) | |
| `qMissingValues` | `array of string` | |
Properties of `qVerifyResult`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT_VERIFIED` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FIELD_VALUE_MATCH_ALL` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `FIELD_MISSING` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `FIELD_VALUE_MISSING` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `STATE_MISSING` | `object` | |
Properties of `qMissingValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### BookmarkList
Lists the bookmarks. Is the layout for _BookmarkListDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxContainerEntry](#nxcontainerentry) | Information about the list of bookmarks. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxContainerEntry` | [NxContainerEntry](#nxcontainerentry) | |
Properties of `NxContainerEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qMeta`
_Properties truncated due to depth limit._
---
### BookmarkListDef
Defines the list of bookmarks.
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | Type of the list. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
| `qIncludePatches` | `boolean` | Include the bookmark patches. Patches can be very large and may make the list result unmanageable. |
---
### BookmarkStateFieldPages
| Name | Type | Description |
| --- | --- | --- |
| `qStatePages` | `array` of [BookmarkFieldPageEx](#bookmarkfieldpageex) | Bookmark field pages for different states. |
Properties of `qStatePages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkFieldPageEx` | [BookmarkFieldPageEx](#bookmarkfieldpageex) | |
Properties of `BookmarkFieldPageEx`
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | The name of the selected state. |
| `qStartIndex` | `integer` | The start value of the range. |
| `qEndIndex` | `integer` | The end value of the range. |
---
### BookmarkVariableItem
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the variable. |
| `qValue` | [FieldValue](#fieldvalue) | |
| `qDefinition` | `string` | The Reporting mode definition of the variable. |
Properties of `qValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
---
### CalendarStrings
| Name | Type | Description |
| --- | --- | --- |
| `qDayNames` | `array of string` | List of short day names. |
| `qMonthNames` | `array of string` | List of short month names. |
| `qLongDayNames` | `array of string` | List of long day names. |
| `qLongMonthNames` | `array of string` | List of long month names. |
Properties of `qDayNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qMonthNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qLongDayNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qLongMonthNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### CharEncodingType
| Name | Type | Description |
| --- | --- | --- |
| `CharEncodingType` | oneOf(Utf8 \| Utf16) | |
Properties of `CharEncodingType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Utf8` | `object` | CHAR_ENCODING_UTF8 |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `Utf16` | `object` | CHAR_ENCODING_UTF16 |
---
### CharRange
| Name | Type | Description |
| --- | --- | --- |
| `qCharPos` | `integer` | Position of the first search occurrence. |
| `qCharCount` | `integer` | Number of occurrences found. |
---
### ChildList
Lists the children of a generic object. Is the layout for _ChildListDef_.
ChildList is used by the _GetLayout Method_ to list the children of a generic object.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxContainerEntry](#nxcontainerentry) | Information about the items in the app object. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxContainerEntry` | [NxContainerEntry](#nxcontainerentry) | |
Properties of `NxContainerEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qMeta`
_Properties truncated due to depth limit._
---
### ChildListDef
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.
| Name | Type | Description |
| --- | --- | --- |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
---
### CodePage
| Name | Type | Description |
| --- | --- | --- |
| `qNumber` | `integer` | Number of the code page. |
| `qName` | `string` | Name of the code page. |
| `qDescription` | `string` | Description of the code page. |
---
### CondDef
| Name | Type | Description |
| --- | --- | --- |
| `qAlways` | `boolean` | |
| `qExpression` | [ValueExpr](#valueexpr) | |
Properties of `qExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
---
### Connection
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the connection. Is generated by the engine and is unique. |
| `qName` | `string` | Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection. |
| `qConnectionString` | `string` | One of: * ODBC CONNECT TO [<provider name>] * OLEDB CONNECT TO [<provider name>] * CUSTOM CONNECT TO [<provider name>] * "<local absolute or relative path, UNC path>" * "<URL>" Connection string. This parameter is mandatory and must be set when creating or modifying a connection. |
| `qType` | `string` | One of: * ODBC * OLEDB * <Name of the custom connection file> * folder * internet Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive. |
| `qUserName` | `string` | Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to _GetConnection Method_ does not return the user name. |
| `qPassword` | `string` | Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to _GetConnection Method_ does not return the password. |
| `qModifiedDate` | `string` | Is generated by the engine. Creation date of the connection or last modification date of the connection. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qLogOn` | oneOf(LOG_ON_SERVICE_USER \| LOG_ON_CURRENT_USER) | |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qLogOn`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG_ON_SERVICE_USER` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG_ON_CURRENT_USER` | `object` | |
---
### ContentLibraryList
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [ContentLibraryListItem](#contentlibrarylistitem) | Information about the content library. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ContentLibraryListItem` | [ContentLibraryListItem](#contentlibrarylistitem) | |
Properties of `ContentLibraryListItem`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the library. |
| `qAppSpecific` | `boolean` | Is set to true if the library is specific to the app (not a global content library). |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
Properties of `qMeta`
_Properties truncated due to depth limit._
---
### ContentLibraryListItem
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the library. |
| `qAppSpecific` | `boolean` | Is set to true if the library is specific to the app (not a global content library). |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### CustomConnector
| Name | Type | Description |
| --- | --- | --- |
| `qProvider` | `string` | Name of the custom connector file. |
| `qParent` | `string` | Name of the parent folder that contains the custom connector file. |
| `qDisplayName` | `string` | Name of the custom connector as displayed in the Qlik interface. |
| `qMachineMode` | oneOf(CONNECT_DEFAULT \| CONNECT_64 \| CONNECT_32) | |
| `qSupportFileStreaming` | `boolean` | |
Properties of `qMachineMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `CONNECT_DEFAULT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `CONNECT_64` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `CONNECT_32` | `object` | |
---
### CyclicGroupPosition
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qActiveField` | `integer` | Active field of the cyclic group, identified by a zero-based index. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### DataField
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qIsKey` | `boolean` | Is set to true if the field is a primary key. |
| `qOriginalFieldName` | `string` | Is shown for fixed records. _qOriginalFieldName_ and _qName_ are identical if no field names are used in the file. _qOriginalFieldName_ differs from _qName_ if embedded file names are used in the file. |
---
### DataRecord
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array of string` | List of values inside the table. The first values (in _result/qPreview/0/qValues_ ) correspond to the field names in the table. The following values (from _result/qPreview/1/qValues_ ) are the values of the fields in the table. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### DataTable
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the table. |
| `qType` | `string` | Type of the table. For example: Table or View. |
---
### DataTableEx
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the table. |
| `qFields` | `array` of [DataField](#datafield) | List of the fields in the table. |
| `qFormatSpec` | `string` | List of format specification items, within brackets. Examples of specification items: * file type * embedded labels, no labels * table is <table name> |
Properties of `qFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DataField` | [DataField](#datafield) | |
Properties of `DataField`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qIsKey` | `boolean` | Is set to true if the field is a primary key. |
| `qOriginalFieldName` | `string` | Is shown for fixed records. _qOriginalFieldName_ and _qName_ are identical if no field names are used in the file. _qOriginalFieldName_ differs from _qName_ if embedded file names are used in the file. |
---
### Database
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the database. |
| `qIsDefault` | `boolean` | Is set to true if the database is set by default. |
---
### DatabaseInfo
| Name | Type | Description |
| --- | --- | --- |
| `qDBMSName` | `string` | Name of the product accessed by the provider. |
| `qDBUsage` | `boolean` | If set to true, it means that the data source contains some databases. |
| `qOwnerUsage` | `boolean` | If set to true, it means that the data source contains some owners. |
| `qDBSeparator` | `string` | Character string used after the database name. Example with separator " **.** ": FROM LinkedTablesData.dbo.Months Where: * **LinkedTablesData** is the database name * **dbo** is the owner name * **Months** is the table name |
| `qOwnerSeparator` | `string` | Character string used after the owner name. Example with separator " **.** ": FROM LinkedTablesData.dbo.Months Where: * **LinkedTablesData** is the database name * **dbo** is the owner name * **Months** is the table name |
| `qDBFirst` | `boolean` | If set to true, it means that the database is displayed first, before the owners and tables. |
| `qQuotePreffix` | `string` | Prefix used with field, database or owner names that contain special characters or keywords. |
| `qQuoteSuffix` | `string` | Suffix used with field, database or owner names that contain special characters or keywords. |
| `qSpecialChars` | `string` | List of the special characters. |
| `qDefaultDatabase` | `string` | Name of the default database. |
| `qKeywords` | `array of string` | List of the script keywords. |
Properties of `qKeywords`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### DatabaseOwner
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the owner. |
---
### DelimiterInfo
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the delimiter. Example: "Tab_DELIMITER" |
| `qScriptCode` | `string` | Representation of the delimiter value that is used in the script. Example: "'\t'" |
| `qNumber` | `integer` | Delimiter character number used by the engine to determine how to separate the values. |
| `qIsMultiple` | `boolean` | Is set to true if multiple spaces are used to separate the values. |
---
### DerivedFieldsInTableData
| Name | Type | Description |
| --- | --- | --- |
| `qDefinitionName` | `string` | Name of the derived definition. |
| `qTags` | `array of string` | List of tags. |
| `qActive` | `boolean` | Is set to true is the derived field is in use. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### DimensionList
Lists the dimensions. Is the layout for _DimensionListDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxContainerEntry](#nxcontainerentry) | Information about the list of dimensions. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxContainerEntry` | [NxContainerEntry](#nxcontainerentry) | |
Properties of `NxContainerEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qMeta`
_Properties truncated due to depth limit._
---
### DimensionListDef
Defines the lists of dimensions.
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | Type of the list. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
---
### DimensionReference
The DimensionReference structure points to a GenericDimension.
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the associated dimension. |
| `qLabel` | `string` | Text label. |
---
### DoReloadExParams
Parameters for a reload.
| Name | Type | Description |
| --- | --- | --- |
| `qMode` | `integer` | 0: for default mode. 1: for ABEND; the reload of the script ends if an error occurs. 2: for ignore; the reload of the script continues even if an error is detected in the script. |
| `qPartial` | `boolean` | Set to true for partial reload. The default value is false. |
| `qDebug` | `boolean` | Set to true to debug reload. The default value is false. |
| `qReloadId` | `string` | Optional reload ID. ID will be automatically generated if not set. |
| `qSkipStore` | `boolean` | Set to true to skip Store statements. The default value is false. |
| `qRowLimit` | `integer` | If greater than or equal 0, defines max number of rows loaded from a data source. |
---
### DoReloadExResult
The result and path to script log for a reload.
| Name | Type | Description |
| --- | --- | --- |
| `qSuccess` | `boolean` | The reload is successful if True. |
| `qScriptLogFile` | `string` | Path to the script log file. |
| `qEndedWithMemoryConstraint` | `boolean` | true if memory limits were exhausted during reload. |
| `qNbrOfLoadedRows` | `integer` | Number of read rows during a reload |
| `qNbrOfStoredRows` | `integer` | Number of stored rows from a reload |
| `qFailureData` | [FailureData](#failuredata) | |
Properties of `qFailureData`
| Name | Type | Description |
| --- | --- | --- |
| `qErrors` | `array` of [ReloadError](#reloaderror) | Array of errors accumulated during reload. |
Properties of `qErrors`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ReloadError` | [ReloadError](#reloaderror) | |
Properties of `ReloadError`
_Properties truncated due to depth limit._
---
### DocListEntry
| Name | Type | Description |
| --- | --- | --- |
| `qDocName` | `string` | Name of the app. |
| `qConnectedUsers` | `integer` | Not used. |
| `qFileTime` | `number` | Last modified time stamp of the app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise. |
| `qFileSize` | `number` | Size of remote app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise. |
| `qDocId` | `string` | Identifier of the app. * In Qlik Sense Desktop, the identifier is the path and name of the app. * In Qlik Sense Enterprise, the identifier is the app's GUID. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qLastReloadTime` | `string` | Last reload time of the app. |
| `qReadOnly` | `boolean` | If set to true, the app is read-only. |
| `qTitle` | `string` | Title of the app. |
| `qThumbnail` | [StaticContentUrl](#staticcontenturl) | In addition, this structure can return dynamic properties.
|
| `qHasSectionAccess` | `boolean` | If true the app has section access configured. |
| `qIsDirectQueryMode` | `boolean` | Is the app a Direct Query app? |
| `qUsage` | oneOf(ANALYTICS \| DATA_PREPARATION \| DATAFLOW_PREP \| SINGLE_TABLE_PREP \| DIRECT_QUERY_MODE) | |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qThumbnail`
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
Properties of `qUsage`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ANALYTICS` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `DATA_PREPARATION` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DATAFLOW_PREP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `SINGLE_TABLE_PREP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `DIRECT_QUERY_MODE` | `object` | |
---
### DriveInfo
| Name | Type | Description |
| --- | --- | --- |
| `qDrive` | `string` | Value of the drive. Examples: C:\\\, E:\\\ |
| `qType` | `string` | Type of the drive. _Fixed_ means physical drive. |
| `qName` | `string` | Name of the drive. |
| `qTypeIdentifier` | oneOf(REMOVABLE \| FIXED \| NETWORK \| CD_ROM \| RAM \| UNKNOWN_TYPE) | |
| `qUnnamedDrive` | `boolean` | |
Properties of `qTypeIdentifier`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `REMOVABLE` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FIXED` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `NETWORK` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `CD_ROM` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `RAM` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `UNKNOWN_TYPE` | `object` | |
---
### DriveType
| Name | Type | Description |
| --- | --- | --- |
| `DriveType` | oneOf(REMOVABLE \| FIXED \| NETWORK \| CD_ROM \| RAM \| UNKNOWN_TYPE) | |
Properties of `DriveType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `REMOVABLE` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FIXED` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `NETWORK` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `CD_ROM` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `RAM` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `UNKNOWN_TYPE` | `object` | |
---
### EditorBreakpoint
| Name | Type | Description |
| --- | --- | --- |
| `qbufferName` | `string` | Name of the breakpoint. |
| `qlineIx` | `integer` | Line number in the script where the breakpoint is set. |
| `qEnabled` | `boolean` | If set to true then the breakpoint is enabled (in use). |
---
### EmbeddedSnapshot
Renders the embedded snapshot in an object.
The following is returned:
* Any dynamic properties defined in the bookmark
* Any properties defined in _qEmbeddedSnapshot_
**Properties**
"qEmbeddedSnapshot": {}
---
### EmbeddedSnapshotDef
Defines the embedded snapshot in a generic object.
**Properties**
"EmbeddedSnapshotDef": {}
---
### ErrorData
| Name | Type | Description |
| --- | --- | --- |
| `qErrorString` | `string` | Detailed information about the error message. |
| `qLineEnd` | `string` | Line termination characters. |
| `qLine` | `string` | Script statement where the error occurs. |
| `qErrorDataCode` | oneOf(EDC_ERROR \| EDC_WARNING \| EDC_CIRCULAR_REFERENCE) | |
| `qMessage` | [ProgressMessage](#progressmessage) | |
Properties of `qErrorDataCode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `EDC_ERROR` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `EDC_WARNING` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `EDC_CIRCULAR_REFERENCE` | `object` | |
Properties of `qMessage`
| Name | Type | Description |
| --- | --- | --- |
| `qMessageCode` | `integer` | Code number to the corresponding localized message string. |
| `qMessageParameters` | `array of string` | Parameters to be inserted in the localized message string. |
Properties of `qMessageParameters`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### ErrorDataCode
| Name | Type | Description |
| --- | --- | --- |
| `ErrorDataCode` | oneOf(EDC_ERROR \| EDC_WARNING \| EDC_CIRCULAR_REFERENCE) | |
Properties of `ErrorDataCode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `EDC_ERROR` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `EDC_WARNING` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `EDC_CIRCULAR_REFERENCE` | `object` | |
---
### ExpansionData
| Name | Type | Description |
| --- | --- | --- |
| `qExcludeList` | `boolean` | |
| `qPos` | [PositionMark](#positionmark) | |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qDimName` | `string` | |
| `qElemNo` | `array of integer` | |
| `qElemValues` | `array` of [Blob](#blob) | |
Properties of `qElemNo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qElemValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `Blob` | [Blob](#blob) | |
---
### ExtendedLayoutBookmarkData
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qActive` | `boolean` | |
| `qShowMode` | `integer` | |
| `qScrollPos` | [ScrollPosition](#scrollposition) | |
| `qExpansionInfo` | `array` of [ExpansionData](#expansiondata) | |
| `qLeftCollapsed` | `boolean` | |
| `qTopCollapsed` | `boolean` | |
| `qSortData` | `array` of [InterFieldSortData](#interfieldsortdata) | |
| `qDimensionGroupPos` | `array` of [GroupStateInfo](#groupstateinfo) | |
| `qExpressionGroupPos` | `array` of [GroupStateInfo](#groupstateinfo) | |
| `qUseGraphMode` | `boolean` | |
| `qGraphMode` | oneOf(GRAPH_MODE_BAR \| GRAPH_MODE_PIE \| GRAPH_MODE_PIVOTTABLE \| GRAPH_MODE_SCATTER \| GRAPH_MODE_LINE \| GRAPH_MODE_STRAIGHTTABLE \| GRAPH_MODE_COMBO \| GRAPH_MODE_RADAR \| GRAPH_MODE_GAUGE \| GRAPH_MODE_GRID \| GRAPH_MODE_BLOCK \| GRAPH_MODE_FUNNEL \| GRAPH_MODE_MEKKO \| GRAPH_MODE_LAST) | |
| `qActiveContainerChildObjectId` | `string` | |
| `qExtendedPivotState` | [ExtendedPivotStateData](#extendedpivotstatedata) | |
Properties of `qScrollPos`
| Name | Type | Description |
| --- | --- | --- |
| `qUsePosition` | `boolean` | |
| `qPos` | [Point](#point) | |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | x-coordinate in pixels. The origin is the top left of the screen. |
| `qy` | `integer` | y-coordinate in pixels. The origin is the top left of the screen. |
Properties of `qExpansionInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ExpansionData` | [ExpansionData](#expansiondata) | |
Properties of `ExpansionData`
| Name | Type | Description |
| --- | --- | --- |
| `qExcludeList` | `boolean` | |
| `qPos` | [PositionMark](#positionmark) | |
Properties of `qPos`
_Properties truncated due to depth limit._
Properties of `qSortData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `InterFieldSortData` | [InterFieldSortData](#interfieldsortdata) | |
Properties of `InterFieldSortData`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | |
| `qReversed` | `boolean` | |
Properties of `qDimensionGroupPos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GroupStateInfo` | [GroupStateInfo](#groupstateinfo) | |
Properties of `GroupStateInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qGroupName` | `string` | |
| `qCurrentItemName` | `string` | |
Properties of `qExpressionGroupPos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GroupStateInfo` | [GroupStateInfo](#groupstateinfo) | |
Properties of `GroupStateInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qGroupName` | `string` | |
| `qCurrentItemName` | `string` | |
Properties of `qGraphMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_BAR` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_PIE` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_PIVOTTABLE` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_SCATTER` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_LINE` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_STRAIGHTTABLE` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_COMBO` | `object` | |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_RADAR` | `object` | |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_GAUGE` | `object` | |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_GRID` | `object` | |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_BLOCK` | `object` | |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_FUNNEL` | `object` | |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_MEKKO` | `object` | |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_LAST` | `object` | |
Properties of `qExtendedPivotState`
| Name | Type | Description |
| --- | --- | --- |
| `qExpressionPosition` | `integer` | |
| `qNumberOfLeftDimensions` | `integer` | |
| `qDimensionNames` | `array of string` | |
| `qEnableConditions` | `array of string` | |
Properties of `qDimensionNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qEnableConditions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### ExtendedPivotStateData
| Name | Type | Description |
| --- | --- | --- |
| `qExpressionPosition` | `integer` | |
| `qNumberOfLeftDimensions` | `integer` | |
| `qDimensionNames` | `array of string` | |
| `qEnableConditions` | `array of string` | |
Properties of `qDimensionNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qEnableConditions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### ExtensionList
Obsolete, use qrs API's to fetch extensions.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array of string` | |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### ExtensionListDef
Obsolete, use qrs API's to fetch extensions.
---
### FailureData
| Name | Type | Description |
| --- | --- | --- |
| `qErrors` | `array` of [ReloadError](#reloaderror) | Array of errors accumulated during reload. |
Properties of `qErrors`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ReloadError` | [ReloadError](#reloaderror) | |
Properties of `ReloadError`
| Name | Type | Description |
| --- | --- | --- |
| `qError` | `string` | Type of error. |
| `qDescription` | `string` | Description of error. |
| `qLine` | `string` | Script line text where error occurred. |
| `qLineNumber` | `integer` | Script line number where error occurred (zero-based). |
| `qCode` | `integer` | Error code. |
| `qTitle` | oneOf(LOCERR_INTERNAL_ERROR \| LOCERR_GENERIC_UNKNOWN \| LOCERR_GENERIC_OK \| LOCERR_GENERIC_NOT_SET \| LOCERR_GENERIC_NOT_FOUND \| LOCERR_GENERIC_ALREADY_EXISTS \| LOCERR_GENERIC_INVALID_PATH \| LOCERR_GENERIC_ACCESS_DENIED \| LOCERR_GENERIC_OUT_OF_MEMORY \| LOCERR_GENERIC_NOT_INITIALIZED \| LOCERR_GENERIC_INVALID_PARAMETERS \| LOCERR_GENERIC_EMPTY_PARAMETERS \| LOCERR_GENERIC_INTERNAL_ERROR \| LOCERR_GENERIC_CORRUPT_DATA \| LOCERR_GENERIC_MEMORY_INCONSISTENCY \| LOCERR_GENERIC_INVISIBLE_OWNER_ABORT \| LOCERR_GENERIC_PROHIBIT_VALIDATE \| LOCERR_GENERIC_ABORTED \| LOCERR_GENERIC_CONNECTION_LOST \| LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION \| LOCERR_GENERIC_REST_CONNECTION_FAILURE \| LOCERR_GENERIC_MEMORY_LIMIT_REACHED \| LOCERR_GENERIC_NOT_IMPLEMENTED \| LOCERR_GENERIC_ENGINE_TERMINATED \| LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED \| LOCERR_HTTP_400 \| LOCERR_HTTP_401 \| LOCERR_HTTP_402 \| LOCERR_HTTP_403 \| LOCERR_HTTP_404 \| LOCERR_HTTP_405 \| LOCERR_HTTP_406 \| LOCERR_HTTP_407 \| LOCERR_HTTP_408 \| LOCERR_HTTP_409 \| LOCERR_HTTP_410 \| LOCERR_HTTP_411 \| LOCERR_HTTP_412 \| LOCERR_HTTP_413 \| LOCERR_HTTP_414 \| LOCERR_HTTP_415 \| LOCERR_HTTP_416 \| LOCERR_HTTP_417 \| LOCERR_HTTP_422 \| LOCERR_HTTP_423 \| LOCERR_HTTP_429 \| LOCERR_HTTP_500 \| LOCERR_HTTP_501 \| LOCERR_HTTP_502 \| LOCERR_HTTP_503 \| LOCERR_HTTP_504 \| LOCERR_HTTP_505 \| LOCERR_HTTP_509 \| LOCERR_HTTP_COULD_NOT_RESOLVE_HOST \| LOCERR_APP_ALREADY_EXISTS \| LOCERR_APP_INVALID_NAME \| LOCERR_APP_ALREADY_OPEN \| LOCERR_APP_NOT_FOUND \| LOCERR_APP_IMPORT_FAILED \| LOCERR_APP_SAVE_FAILED \| LOCERR_APP_CREATE_FAILED \| LOCERR_APP_INVALID \| LOCERR_APP_CONNECT_FAILED \| LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE \| LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE \| LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION \| LOCERR_APP_MIGRATION_FAILURE \| LOCERR_APP_SCRIPT_MISSING \| LOCERR_APP_EXPORT_FAILED \| LOCERR_APP_SIZE_EXCEEDED \| LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED \| LOCERR_APP_NOT_OPEN \| LOCERR_APP_EVENT_SOURCE_TIMEOUT \| LOCERR_CONNECTION_ALREADY_EXISTS \| LOCERR_CONNECTION_NOT_FOUND \| LOCERR_CONNECTION_FAILED_TO_LOAD \| LOCERR_CONNECTION_FAILED_TO_IMPORT \| LOCERR_CONNECTION_NAME_IS_INVALID \| LOCERR_CONNECTION_MISSING_CREDENTIALS \| LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT \| LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE \| LOCERR_FILE_ACCESS_DENIED \| LOCERR_FILE_NAME_INVALID \| LOCERR_FILE_CORRUPT \| LOCERR_FILE_NOT_FOUND \| LOCERR_FILE_FORMAT_UNSUPPORTED \| LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE \| LOCERR_FILE_TABLE_NOT_FOUND \| LOCERR_USER_ACCESS_DENIED \| LOCERR_USER_IMPERSONATION_FAILED \| LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS \| LOCERR_SERVER_OUT_OF_SESSION_CALS \| LOCERR_SERVER_OUT_OF_USAGE_CALS \| LOCERR_SERVER_OUT_OF_CALS \| LOCERR_SERVER_OUT_OF_NAMED_CALS \| LOCERR_SERVER_OFF_DUTY \| LOCERR_SERVER_BUSY \| LOCERR_SERVER_LICENSE_EXPIRED \| LOCERR_SERVER_AJAX_DISABLED \| LOCERR_SERVER_NO_TOKEN \| LOCERR_HC_INVALID_OBJECT \| LOCERR_HC_RESULT_TOO_LARGE \| LOCERR_HC_INVALID_OBJECT_STATE \| LOCERR_HC_MODAL_OBJECT_ERROR \| LOCERR_CALC_INVALID_DEF \| LOCERR_CALC_NOT_IN_LIB \| LOCERR_CALC_HEAP_ERROR \| LOCERR_CALC_TOO_LARGE \| LOCERR_CALC_TIMEOUT \| LOCERR_CALC_EVAL_CONDITION_FAILED \| LOCERR_CALC_MIXED_LINKED_AGGREGATION \| LOCERR_CALC_MISSING_LINKED \| LOCERR_CALC_INVALID_COL_SORT \| LOCERR_CALC_PAGES_TOO_LARGE \| LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED \| LOCERR_CALC_VALIDATION_STATE_INVALID \| LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS \| LOCERR_CALC_MISSING_LINKED_FIELD \| LOCERR_CALC_NOT_CALCULATED \| LOCERR_LAYOUT_EXTENDS_INVALID_ID \| LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND \| LOCERR_LAYOUT_LINKED_OBJECT_INVALID \| LOCERR_PERSISTENCE_WRITE_FAILED \| LOCERR_PERSISTENCE_READ_FAILED \| LOCERR_PERSISTENCE_DELETE_FAILED \| LOCERR_PERSISTENCE_NOT_FOUND \| LOCERR_PERSISTENCE_UNSUPPORTED_VERSION \| LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY \| LOCERR_PERSISTENCE_MIGRATION_CANCELLED \| LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED \| LOCERR_PERSISTENCE_DISK_FULL \| LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP \| LOCERR_PERSISTENCE_MOVE_FAILED \| LOCERR_PERSISTENCE_OBJECT_LOCKED \| LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING \| LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS \| LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS \| LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED \| LOCERR_RELOAD_IN_PROGRESS \| LOCERR_RELOAD_TABLE_X_NOT_FOUND \| LOCERR_RELOAD_UNKNOWN_STATEMENT \| LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_FIELD_X_NOT_FOUND \| LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND \| LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND \| LOCERR_RELOAD_NAME_ALREADY_TAKEN \| LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF \| LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF \| LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED \| LOCERR_RELOAD_OPEN_FILE_ERROR \| LOCERR_RELOAD_AUTO_GENERATE_COUNT \| LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB \| LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR \| LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND \| LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID \| LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE \| LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE \| LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS \| LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS \| LOCERR_RELOAD_NO_OPEN_DATABASE \| LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY \| LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE \| LOCERR_RELOAD_ODBC_CONNECT_FAILED \| LOCERR_RELOAD_OLEDB_CONNECT_FAILED \| LOCERR_RELOAD_CUSTOM_CONNECT_FAILED \| LOCERR_RELOAD_ODBC_READ_FAILED \| LOCERR_RELOAD_OLEDB_READ_FAILED \| LOCERR_RELOAD_CUSTOM_READ_FAILED \| LOCERR_RELOAD_BINARY_LOAD_PROHIBITED \| LOCERR_RELOAD_CONNECTOR_START_FAILED \| LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING \| LOCERR_RELOAD_CONNECTOR_REPLY_ERROR \| LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR \| LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR \| LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS \| LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE \| LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD \| LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT \| LOCERR_RELOAD_EXIT_ERROR \| LOCERR_PERSONAL_NEW_VERSION_AVAILABLE \| LOCERR_PERSONAL_VERSION_EXPIRED \| LOCERR_PERSONAL_SECTION_ACCESS_DETECTED \| LOCERR_PERSONAL_APP_DELETION_FAILED \| LOCERR_USER_AUTHENTICATION_FAILURE \| LOCERR_EXPORT_OUT_OF_MEMORY \| LOCERR_EXPORT_NO_DATA \| LOCERR_SYNC_INVALID_OFFSET \| LOCERR_SEARCH_TIMEOUT \| LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL \| LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW \| LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT \| LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED \| LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED \| LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED \| LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED \| LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED \| LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED \| LOCERR_SMART_LOAD_TABLE_NOT_FOUND \| LOCERR_SMART_LOAD_TABLE_DUPLICATED \| LOCERR_VARIABLE_NO_NAME \| LOCERR_VARIABLE_DUPLICATE_NAME \| LOCERR_VARIABLE_INCONSISTENCY \| LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY \| LOCERR_VARIABLE_CONSTRAINT_FAILED \| LOCERR_MEDIA_LIBRARY_LIST_FAILED \| LOCERR_MEDIA_LIBRARY_CONTENT_FAILED \| LOCERR_MEDIA_BUNDLING_FAILED \| LOCERR_MEDIA_UNBUNDLING_FAILED \| LOCERR_MEDIA_LIBRARY_NOT_FOUND \| LOCERR_FEATURE_DISABLED \| LOCERR_LOAD_TOO_MANY_FIELDS \| LOCERR_LOAD_TOO_MANY_TABLES \| LOCERR_JSON_RPC_INVALID_REQUEST \| LOCERR_JSON_RPC_METHOD_NOT_FOUND \| LOCERR_JSON_RPC_INVALID_PARAMETERS \| LOCERR_JSON_RPC_INTERNAL_ERROR \| LOCERR_JSON_RPC_RESPONSE_TOO_LARGE \| LOCERR_JSON_RPC_PARSE_ERROR \| LOCERR_MQ_SOCKET_CONNECT_FAILURE \| LOCERR_MQ_SOCKET_OPEN_FAILURE \| LOCERR_MQ_PROTOCOL_NO_RESPONE \| LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION \| LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED \| LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED \| LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR \| LOCERR_MQ_PROTOCOL_INVALID_STATUS \| LOCERR_EXTENGINE_GRPC_STATUS_OK \| LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED \| LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN \| LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT \| LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED \| LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND \| LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS \| LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED \| LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED \| LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION \| LOCERR_EXTENGINE_GRPC_STATUS_ABORTED \| LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE \| LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED \| LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL \| LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE \| LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS \| LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED \| LOCERR_LXW_INVALID_OBJ \| LOCERR_LXW_INVALID_FILE \| LOCERR_LXW_INVALID_SHEET \| LOCERR_LXW_INVALID_EXPORT_RANGE \| LOCERR_LXW_ERROR \| LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED \| LOCERR_LXW_ERROR_CREATING_XLSX_FILE \| LOCERR_LXW_ERROR_CREATING_TMPFILE \| LOCERR_LXW_ERROR_ZIP_FILE_OPERATION \| LOCERR_LXW_ERROR_ZIP_FILE_ADD \| LOCERR_LXW_ERROR_ZIP_CLOSE \| LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED \| LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED \| LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED \| LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND \| LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE \| LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED \| LOCERR_BDI_STATUS_OK \| LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED \| LOCERR_TRENDLINE_INVALID_DEF \| LOCERR_TRENDLINE_INVALID_MATH_ERROR \| LOCERR_CURL_UNSUPPORTED_PROTOCOL \| LOCERR_CURL_COULDNT_RESOLVE_PROXY \| LOCERR_CURL_COULDNT_CONNECT \| LOCERR_CURL_REMOTE_ACCESS_DENIED \| LOCERR_CURL_FTP_ACCEPT_FAILED \| LOCERR_CURL_FTP_ACCEPT_TIMEOUT \| LOCERR_CURL_FTP_CANT_GET_HOST \| LOCERR_CURL_PARTIAL_FILE \| LOCERR_CURL_QUOTE_ERROR \| LOCERR_CURL_WRITE_ERROR \| LOCERR_CURL_UPLOAD_FAILED \| LOCERR_CURL_OUT_OF_MEMORY \| LOCERR_CURL_OPERATION_TIMEDOUT \| LOCERR_CURL_FTP_COULDNT_USE_REST \| LOCERR_CURL_HTTP_POST_ERROR \| LOCERR_CURL_SSL_CONNECT_ERROR \| LOCERR_CURL_FILE_COULDNT_READ_FILE \| LOCERR_CURL_LDAP_CANNOT_BIND \| LOCERR_CURL_LDAP_SEARCH_FAILED \| LOCERR_CURL_TOO_MANY_REDIRECTS \| LOCERR_CURL_PEER_FAILED_VERIFICATION \| LOCERR_CURL_GOT_NOTHING \| LOCERR_CURL_SSL_ENGINE_NOTFOUND \| LOCERR_CURL_SSL_ENGINE_SETFAILED \| LOCERR_CURL_SSL_CERTPROBLEM \| LOCERR_CURL_SSL_CIPHER \| LOCERR_CURL_SSL_CACERT \| LOCERR_CURL_BAD_CONTENT_ENCODING \| LOCERR_CURL_LDAP_INVALID_URL \| LOCERR_CURL_USE_SSL_FAILED \| LOCERR_CURL_SSL_ENGINE_INITFAILED \| LOCERR_CURL_LOGIN_DENIED \| LOCERR_CURL_TFTP_NOTFOUND \| LOCERR_CURL_TFTP_ILLEGAL \| LOCERR_CURL_SSH \| LOCERR_SETEXPRESSION_TOO_LARGE \| LOCERR_RELOAD_MERGE_LOAD_ERROR \| LOCERR_WIN_FTP_DROPPED \| LOCERR_WIN_FTP_NO_PASSIVE_MODE \| LOCERR_WIN_HTTP_DOWNLEVEL_SERVER \| LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE \| LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION \| LOCERR_WIN_INTERNET_FORCE_RETRY \| LOCERR_WIN_INTERNET_CANNOT_CONNECT \| LOCERR_WIN_INTERNET_CONNECTION_ABORTED \| LOCERR_WIN_INTERNET_CONNECTION_RESET \| LOCERR_WIN_INTERNET_DISCONNECTED \| LOCERR_WIN_INTERNET_INCORRECT_FORMAT \| LOCERR_WIN_INTERNET_INVALID_CA \| LOCERR_WIN_INTERNET_INVALID_OPERATION \| LOCERR_WIN_INTERNET_INVALID_URL \| LOCERR_WIN_INTERNET_ITEM_NOT_FOUND \| LOCERR_WIN_INTERNET_LOGIN_FAILURE \| LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED \| LOCERR_WIN_INTERNET_NEED_UI \| LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID \| LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID \| LOCERR_WIN_INTERNET_SEC_CERT_ERRORS \| LOCERR_WIN_INTERNET_SEC_INVALID_CERT \| LOCERR_WIN_INTERNET_SERVER_UNREACHABLE \| LOCERR_BM_RESULT_TOO_LARGE) | |
Properties of `qTitle`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
**Option 11:**
_Properties truncated due to depth limit._
**Option 12:**
_Properties truncated due to depth limit._
**Option 13:**
_Properties truncated due to depth limit._
**Option 14:**
_Properties truncated due to depth limit._
**Option 15:**
_Properties truncated due to depth limit._
**Option 16:**
_Properties truncated due to depth limit._
**Option 17:**
_Properties truncated due to depth limit._
**Option 18:**
_Properties truncated due to depth limit._
**Option 19:**
_Properties truncated due to depth limit._
**Option 20:**
_Properties truncated due to depth limit._
**Option 21:**
_Properties truncated due to depth limit._
**Option 22:**
_Properties truncated due to depth limit._
**Option 23:**
_Properties truncated due to depth limit._
**Option 24:**
_Properties truncated due to depth limit._
**Option 25:**
_Properties truncated due to depth limit._
**Option 26:**
_Properties truncated due to depth limit._
**Option 27:**
_Properties truncated due to depth limit._
**Option 28:**
_Properties truncated due to depth limit._
**Option 29:**
_Properties truncated due to depth limit._
**Option 30:**
_Properties truncated due to depth limit._
**Option 31:**
_Properties truncated due to depth limit._
**Option 32:**
_Properties truncated due to depth limit._
**Option 33:**
_Properties truncated due to depth limit._
**Option 34:**
_Properties truncated due to depth limit._
**Option 35:**
_Properties truncated due to depth limit._
**Option 36:**
_Properties truncated due to depth limit._
**Option 37:**
_Properties truncated due to depth limit._
**Option 38:**
_Properties truncated due to depth limit._
**Option 39:**
_Properties truncated due to depth limit._
**Option 40:**
_Properties truncated due to depth limit._
**Option 41:**
_Properties truncated due to depth limit._
**Option 42:**
_Properties truncated due to depth limit._
**Option 43:**
_Properties truncated due to depth limit._
**Option 44:**
_Properties truncated due to depth limit._
**Option 45:**
_Properties truncated due to depth limit._
**Option 46:**
_Properties truncated due to depth limit._
**Option 47:**
_Properties truncated due to depth limit._
**Option 48:**
_Properties truncated due to depth limit._
**Option 49:**
_Properties truncated due to depth limit._
**Option 50:**
_Properties truncated due to depth limit._
**Option 51:**
_Properties truncated due to depth limit._
**Option 52:**
_Properties truncated due to depth limit._
**Option 53:**
_Properties truncated due to depth limit._
**Option 54:**
_Properties truncated due to depth limit._
**Option 55:**
_Properties truncated due to depth limit._
**Option 56:**
_Properties truncated due to depth limit._
**Option 57:**
_Properties truncated due to depth limit._
**Option 58:**
_Properties truncated due to depth limit._
**Option 59:**
_Properties truncated due to depth limit._
**Option 60:**
_Properties truncated due to depth limit._
**Option 61:**
_Properties truncated due to depth limit._
**Option 62:**
_Properties truncated due to depth limit._
**Option 63:**
_Properties truncated due to depth limit._
**Option 64:**
_Properties truncated due to depth limit._
**Option 65:**
_Properties truncated due to depth limit._
**Option 66:**
_Properties truncated due to depth limit._
**Option 67:**
_Properties truncated due to depth limit._
**Option 68:**
_Properties truncated due to depth limit._
**Option 69:**
_Properties truncated due to depth limit._
**Option 70:**
_Properties truncated due to depth limit._
**Option 71:**
_Properties truncated due to depth limit._
**Option 72:**
_Properties truncated due to depth limit._
**Option 73:**
_Properties truncated due to depth limit._
**Option 74:**
_Properties truncated due to depth limit._
**Option 75:**
_Properties truncated due to depth limit._
**Option 76:**
_Properties truncated due to depth limit._
**Option 77:**
_Properties truncated due to depth limit._
**Option 78:**
_Properties truncated due to depth limit._
**Option 79:**
_Properties truncated due to depth limit._
**Option 80:**
_Properties truncated due to depth limit._
**Option 81:**
_Properties truncated due to depth limit._
**Option 82:**
_Properties truncated due to depth limit._
**Option 83:**
_Properties truncated due to depth limit._
**Option 84:**
_Properties truncated due to depth limit._
**Option 85:**
_Properties truncated due to depth limit._
**Option 86:**
_Properties truncated due to depth limit._
**Option 87:**
_Properties truncated due to depth limit._
**Option 88:**
_Properties truncated due to depth limit._
**Option 89:**
_Properties truncated due to depth limit._
**Option 90:**
_Properties truncated due to depth limit._
**Option 91:**
_Properties truncated due to depth limit._
**Option 92:**
_Properties truncated due to depth limit._
**Option 93:**
_Properties truncated due to depth limit._
**Option 94:**
_Properties truncated due to depth limit._
**Option 95:**
_Properties truncated due to depth limit._
**Option 96:**
_Properties truncated due to depth limit._
**Option 97:**
_Properties truncated due to depth limit._
**Option 98:**
_Properties truncated due to depth limit._
**Option 99:**
_Properties truncated due to depth limit._
**Option 100:**
_Properties truncated due to depth limit._
**Option 101:**
_Properties truncated due to depth limit._
**Option 102:**
_Properties truncated due to depth limit._
**Option 103:**
_Properties truncated due to depth limit._
**Option 104:**
_Properties truncated due to depth limit._
**Option 105:**
_Properties truncated due to depth limit._
**Option 106:**
_Properties truncated due to depth limit._
**Option 107:**
_Properties truncated due to depth limit._
**Option 108:**
_Properties truncated due to depth limit._
**Option 109:**
_Properties truncated due to depth limit._
**Option 110:**
_Properties truncated due to depth limit._
**Option 111:**
_Properties truncated due to depth limit._
**Option 112:**
_Properties truncated due to depth limit._
**Option 113:**
_Properties truncated due to depth limit._
**Option 114:**
_Properties truncated due to depth limit._
**Option 115:**
_Properties truncated due to depth limit._
**Option 116:**
_Properties truncated due to depth limit._
**Option 117:**
_Properties truncated due to depth limit._
**Option 118:**
_Properties truncated due to depth limit._
**Option 119:**
_Properties truncated due to depth limit._
**Option 120:**
_Properties truncated due to depth limit._
**Option 121:**
_Properties truncated due to depth limit._
**Option 122:**
_Properties truncated due to depth limit._
**Option 123:**
_Properties truncated due to depth limit._
**Option 124:**
_Properties truncated due to depth limit._
**Option 125:**
_Properties truncated due to depth limit._
**Option 126:**
_Properties truncated due to depth limit._
**Option 127:**
_Properties truncated due to depth limit._
**Option 128:**
_Properties truncated due to depth limit._
**Option 129:**
_Properties truncated due to depth limit._
**Option 130:**
_Properties truncated due to depth limit._
**Option 131:**
_Properties truncated due to depth limit._
**Option 132:**
_Properties truncated due to depth limit._
**Option 133:**
_Properties truncated due to depth limit._
**Option 134:**
_Properties truncated due to depth limit._
**Option 135:**
_Properties truncated due to depth limit._
**Option 136:**
_Properties truncated due to depth limit._
**Option 137:**
_Properties truncated due to depth limit._
**Option 138:**
_Properties truncated due to depth limit._
**Option 139:**
_Properties truncated due to depth limit._
**Option 140:**
_Properties truncated due to depth limit._
**Option 141:**
_Properties truncated due to depth limit._
**Option 142:**
_Properties truncated due to depth limit._
**Option 143:**
_Properties truncated due to depth limit._
**Option 144:**
_Properties truncated due to depth limit._
**Option 145:**
_Properties truncated due to depth limit._
**Option 146:**
_Properties truncated due to depth limit._
**Option 147:**
_Properties truncated due to depth limit._
**Option 148:**
_Properties truncated due to depth limit._
**Option 149:**
_Properties truncated due to depth limit._
**Option 150:**
_Properties truncated due to depth limit._
**Option 151:**
_Properties truncated due to depth limit._
**Option 152:**
_Properties truncated due to depth limit._
**Option 153:**
_Properties truncated due to depth limit._
**Option 154:**
_Properties truncated due to depth limit._
**Option 155:**
_Properties truncated due to depth limit._
**Option 156:**
_Properties truncated due to depth limit._
**Option 157:**
_Properties truncated due to depth limit._
**Option 158:**
_Properties truncated due to depth limit._
**Option 159:**
_Properties truncated due to depth limit._
**Option 160:**
_Properties truncated due to depth limit._
**Option 161:**
_Properties truncated due to depth limit._
**Option 162:**
_Properties truncated due to depth limit._
**Option 163:**
_Properties truncated due to depth limit._
**Option 164:**
_Properties truncated due to depth limit._
**Option 165:**
_Properties truncated due to depth limit._
**Option 166:**
_Properties truncated due to depth limit._
**Option 167:**
_Properties truncated due to depth limit._
**Option 168:**
_Properties truncated due to depth limit._
**Option 169:**
_Properties truncated due to depth limit._
**Option 170:**
_Properties truncated due to depth limit._
**Option 171:**
_Properties truncated due to depth limit._
**Option 172:**
_Properties truncated due to depth limit._
**Option 173:**
_Properties truncated due to depth limit._
**Option 174:**
_Properties truncated due to depth limit._
**Option 175:**
_Properties truncated due to depth limit._
**Option 176:**
_Properties truncated due to depth limit._
**Option 177:**
_Properties truncated due to depth limit._
**Option 178:**
_Properties truncated due to depth limit._
**Option 179:**
_Properties truncated due to depth limit._
**Option 180:**
_Properties truncated due to depth limit._
**Option 181:**
_Properties truncated due to depth limit._
**Option 182:**
_Properties truncated due to depth limit._
**Option 183:**
_Properties truncated due to depth limit._
**Option 184:**
_Properties truncated due to depth limit._
**Option 185:**
_Properties truncated due to depth limit._
**Option 186:**
_Properties truncated due to depth limit._
**Option 187:**
_Properties truncated due to depth limit._
**Option 188:**
_Properties truncated due to depth limit._
**Option 189:**
_Properties truncated due to depth limit._
**Option 190:**
_Properties truncated due to depth limit._
**Option 191:**
_Properties truncated due to depth limit._
**Option 192:**
_Properties truncated due to depth limit._
**Option 193:**
_Properties truncated due to depth limit._
**Option 194:**
_Properties truncated due to depth limit._
**Option 195:**
_Properties truncated due to depth limit._
**Option 196:**
_Properties truncated due to depth limit._
**Option 197:**
_Properties truncated due to depth limit._
**Option 198:**
_Properties truncated due to depth limit._
**Option 199:**
_Properties truncated due to depth limit._
**Option 200:**
_Properties truncated due to depth limit._
**Option 201:**
_Properties truncated due to depth limit._
**Option 202:**
_Properties truncated due to depth limit._
**Option 203:**
_Properties truncated due to depth limit._
**Option 204:**
_Properties truncated due to depth limit._
**Option 205:**
_Properties truncated due to depth limit._
**Option 206:**
_Properties truncated due to depth limit._
**Option 207:**
_Properties truncated due to depth limit._
**Option 208:**
_Properties truncated due to depth limit._
**Option 209:**
_Properties truncated due to depth limit._
**Option 210:**
_Properties truncated due to depth limit._
**Option 211:**
_Properties truncated due to depth limit._
**Option 212:**
_Properties truncated due to depth limit._
**Option 213:**
_Properties truncated due to depth limit._
**Option 214:**
_Properties truncated due to depth limit._
**Option 215:**
_Properties truncated due to depth limit._
**Option 216:**
_Properties truncated due to depth limit._
**Option 217:**
_Properties truncated due to depth limit._
**Option 218:**
_Properties truncated due to depth limit._
**Option 219:**
_Properties truncated due to depth limit._
**Option 220:**
_Properties truncated due to depth limit._
**Option 221:**
_Properties truncated due to depth limit._
**Option 222:**
_Properties truncated due to depth limit._
**Option 223:**
_Properties truncated due to depth limit._
**Option 224:**
_Properties truncated due to depth limit._
**Option 225:**
_Properties truncated due to depth limit._
**Option 226:**
_Properties truncated due to depth limit._
**Option 227:**
_Properties truncated due to depth limit._
**Option 228:**
_Properties truncated due to depth limit._
**Option 229:**
_Properties truncated due to depth limit._
**Option 230:**
_Properties truncated due to depth limit._
**Option 231:**
_Properties truncated due to depth limit._
**Option 232:**
_Properties truncated due to depth limit._
**Option 233:**
_Properties truncated due to depth limit._
**Option 234:**
_Properties truncated due to depth limit._
**Option 235:**
_Properties truncated due to depth limit._
**Option 236:**
_Properties truncated due to depth limit._
**Option 237:**
_Properties truncated due to depth limit._
**Option 238:**
_Properties truncated due to depth limit._
**Option 239:**
_Properties truncated due to depth limit._
**Option 240:**
_Properties truncated due to depth limit._
**Option 241:**
_Properties truncated due to depth limit._
**Option 242:**
_Properties truncated due to depth limit._
**Option 243:**
_Properties truncated due to depth limit._
**Option 244:**
_Properties truncated due to depth limit._
**Option 245:**
_Properties truncated due to depth limit._
**Option 246:**
_Properties truncated due to depth limit._
**Option 247:**
_Properties truncated due to depth limit._
**Option 248:**
_Properties truncated due to depth limit._
**Option 249:**
_Properties truncated due to depth limit._
**Option 250:**
_Properties truncated due to depth limit._
**Option 251:**
_Properties truncated due to depth limit._
**Option 252:**
_Properties truncated due to depth limit._
**Option 253:**
_Properties truncated due to depth limit._
**Option 254:**
_Properties truncated due to depth limit._
**Option 255:**
_Properties truncated due to depth limit._
**Option 256:**
_Properties truncated due to depth limit._
**Option 257:**
_Properties truncated due to depth limit._
**Option 258:**
_Properties truncated due to depth limit._
**Option 259:**
_Properties truncated due to depth limit._
**Option 260:**
_Properties truncated due to depth limit._
**Option 261:**
_Properties truncated due to depth limit._
**Option 262:**
_Properties truncated due to depth limit._
**Option 263:**
_Properties truncated due to depth limit._
**Option 264:**
_Properties truncated due to depth limit._
**Option 265:**
_Properties truncated due to depth limit._
**Option 266:**
_Properties truncated due to depth limit._
**Option 267:**
_Properties truncated due to depth limit._
**Option 268:**
_Properties truncated due to depth limit._
**Option 269:**
_Properties truncated due to depth limit._
**Option 270:**
_Properties truncated due to depth limit._
**Option 271:**
_Properties truncated due to depth limit._
**Option 272:**
_Properties truncated due to depth limit._
**Option 273:**
_Properties truncated due to depth limit._
**Option 274:**
_Properties truncated due to depth limit._
**Option 275:**
_Properties truncated due to depth limit._
**Option 276:**
_Properties truncated due to depth limit._
**Option 277:**
_Properties truncated due to depth limit._
**Option 278:**
_Properties truncated due to depth limit._
**Option 279:**
_Properties truncated due to depth limit._
**Option 280:**
_Properties truncated due to depth limit._
**Option 281:**
_Properties truncated due to depth limit._
**Option 282:**
_Properties truncated due to depth limit._
**Option 283:**
_Properties truncated due to depth limit._
**Option 284:**
_Properties truncated due to depth limit._
**Option 285:**
_Properties truncated due to depth limit._
**Option 286:**
_Properties truncated due to depth limit._
**Option 287:**
_Properties truncated due to depth limit._
**Option 288:**
_Properties truncated due to depth limit._
**Option 289:**
_Properties truncated due to depth limit._
**Option 290:**
_Properties truncated due to depth limit._
**Option 291:**
_Properties truncated due to depth limit._
**Option 292:**
_Properties truncated due to depth limit._
**Option 293:**
_Properties truncated due to depth limit._
**Option 294:**
_Properties truncated due to depth limit._
**Option 295:**
_Properties truncated due to depth limit._
**Option 296:**
_Properties truncated due to depth limit._
**Option 297:**
_Properties truncated due to depth limit._
**Option 298:**
_Properties truncated due to depth limit._
**Option 299:**
_Properties truncated due to depth limit._
**Option 300:**
_Properties truncated due to depth limit._
**Option 301:**
_Properties truncated due to depth limit._
**Option 302:**
_Properties truncated due to depth limit._
**Option 303:**
_Properties truncated due to depth limit._
**Option 304:**
_Properties truncated due to depth limit._
**Option 305:**
_Properties truncated due to depth limit._
**Option 306:**
_Properties truncated due to depth limit._
**Option 307:**
_Properties truncated due to depth limit._
**Option 308:**
_Properties truncated due to depth limit._
**Option 309:**
_Properties truncated due to depth limit._
**Option 310:**
_Properties truncated due to depth limit._
**Option 311:**
_Properties truncated due to depth limit._
**Option 312:**
_Properties truncated due to depth limit._
**Option 313:**
_Properties truncated due to depth limit._
**Option 314:**
_Properties truncated due to depth limit._
**Option 315:**
_Properties truncated due to depth limit._
**Option 316:**
_Properties truncated due to depth limit._
**Option 317:**
_Properties truncated due to depth limit._
**Option 318:**
_Properties truncated due to depth limit._
**Option 319:**
_Properties truncated due to depth limit._
**Option 320:**
_Properties truncated due to depth limit._
**Option 321:**
_Properties truncated due to depth limit._
**Option 322:**
_Properties truncated due to depth limit._
**Option 323:**
_Properties truncated due to depth limit._
**Option 324:**
_Properties truncated due to depth limit._
**Option 325:**
_Properties truncated due to depth limit._
**Option 326:**
_Properties truncated due to depth limit._
**Option 327:**
_Properties truncated due to depth limit._
**Option 328:**
_Properties truncated due to depth limit._
**Option 329:**
_Properties truncated due to depth limit._
**Option 330:**
_Properties truncated due to depth limit._
**Option 331:**
_Properties truncated due to depth limit._
**Option 332:**
_Properties truncated due to depth limit._
**Option 333:**
_Properties truncated due to depth limit._
**Option 334:**
_Properties truncated due to depth limit._
---
### FieldAttrType
| Name | Type | Description |
| --- | --- | --- |
| `FieldAttrType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
Properties of `FieldAttrType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
---
### FieldAttributes
Sets the formatting of a field.
The properties of _qFieldAttributes_ and the formatting mechanism are described below.
**Formatting mechanism**
The formatting mechanism depends on the type set in _qType,_ as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
**Type is DATE, TIME, TIMESTAMP or INTERVAL**
The following applies:
* If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .
* If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).
* The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
**Type is INTEGER**
The following applies:
* If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used .
**Type is REAL**
The following applies:
* If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.
* If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
* If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
**Type is FIX**
The following applies:
* If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).
* If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.
**Type is MONEY**
The following applies:
* If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
* If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).
**Type is ASCII**
No formatting, _qFmt_ is ignored.
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
---
### FieldDefEx
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qType` | oneOf(NOT_PRESENT \| PRESENT \| IS_CYCLIC_GROUP \| IS_DRILL_GROUP \| IS_VAR \| IS_EXPR \| IS_IMPLICIT \| IS_DETAIL) | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT_PRESENT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `PRESENT` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_CYCLIC_GROUP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_DRILL_GROUP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_VAR` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_EXPR` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_IMPLICIT` | `object` | |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_DETAIL` | `object` | |
---
### FieldDescription
| Name | Type | Description |
| --- | --- | --- |
| `qInternalNumber` | `integer` | Internal number of the field. |
| `qName` | `string` | Name of the field. |
| `qSrcTables` | `array of string` | List of table names. |
| `qIsSystem` | `boolean` | If set to true, it means that the field is a system field. The default value is false. |
| `qIsHidden` | `boolean` | If set to true, it means that the field is hidden. The default value is false. |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. The default value is false. |
| `qDistinctOnly` | `boolean` | If set to true, only distinct field values are shown. The default value is false. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qTotalCount` | `integer` | Total number of field values. |
| `qPossibleCount_OBSOLETE` | `integer` | |
| `qHasInfo_OBSOLETE` | `boolean` | |
| `qIsLocked` | `boolean` | If set to true, it means that the field is locked. The default value is false. |
| `qAlwaysOneSelected` | `boolean` | If set to true, it means that the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false. |
| `qAndMode` | `boolean` | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. The default value is false. |
| `qComment` | `string` | Field comment. |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII. |
| `qIsDefinitionOnly` | `boolean` | If set to true, it means that the field is a field on the fly. The default value is false. |
| `qByteSize` | `integer` | Static RAM memory used in bytes. |
Properties of `qSrcTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### FieldInTableData
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qOriginalFields` | `array of string` | Is shown for fixed records. _qOriginalFieldName_ and _qName_ are identical if no field names are used in the file. _qOriginalFieldName_ differs from _qName_ if embedded file names are used in the file. |
| `qPresent` | `boolean` | |
| `qHasNull` | `boolean` | This property is set to true if the field contains some Null values. |
| `qHasWild` | `boolean` | |
| `qHasDuplicates` | `boolean` | This property is set to true if the field contains some duplicate values. |
| `qIsSynthetic` | `boolean` | This property is set to true if the field contains a synthetic key. |
| `qInformationDensity` | `number` | Number of records that have values (for example, not NULL) in the field as compared to the total number of records in the table. |
| `qnNonNulls` | `integer` | Number of values that are non Null. |
| `qnRows` | `integer` | Number of rows in the field. |
| `qSubsetRatio` | `number` | Number of distinct values in the field (in the current table) as compared to the total number of distinct values of this field (in all tables). |
| `qnTotalDistinctValues` | `integer` | Number of distinct values in the field. |
| `qnPresentDistinctValues` | `integer` | |
| `qKeyType` | oneOf(NOT_KEY \| ANY_KEY \| PRIMARY_KEY \| PERFECT_KEY) | |
| `qComment` | `string` | Comment related to the field. |
| `qTags` | `array of string` | List of tags related to the field. |
| `qDerivedFields` | `array` of [DerivedFieldsInTableData](#derivedfieldsintabledata) | List of the derived fields. |
| `qIsFieldOnTheFly` | `boolean` | |
| `qReadableName` | `string` | |
Properties of `qOriginalFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qKeyType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT_KEY` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `ANY_KEY` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `PRIMARY_KEY` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `PERFECT_KEY` | `object` | |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qDerivedFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DerivedFieldsInTableData` | [DerivedFieldsInTableData](#derivedfieldsintabledata) | |
Properties of `DerivedFieldsInTableData`
| Name | Type | Description |
| --- | --- | --- |
| `qDefinitionName` | `string` | Name of the derived definition. |
| `qTags` | `array of string` | List of tags. |
| `qActive` | `boolean` | Is set to true is the derived field is in use. |
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
---
### FieldInTableProfilingData
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qFieldTags` | `array of string` | List of tags related to the field. |
| `qNumberFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qDistinctValues` | `integer` | Number of distinct values |
| `qDistinctNumericValues` | `integer` | Number of distinct numeric values |
| `qDistinctTextValues` | `integer` | Number of distinct text values |
| `qNumericValues` | `integer` | Number of numeric values |
| `qNullValues` | `integer` | Number of null values |
| `qTextValues` | `integer` | Number of textual values |
| `qNegValues` | `integer` | Number of negative values |
| `qPosValues` | `integer` | Number of positive values |
| `qZeroValues` | `integer` | Number of zero values for numerical values |
| `qSum` | `number` | Sum of all numerical values. NaN otherwise. |
| `qSum2` | `number` | Squared sum of all numerical values. NaN otherwise. |
| `qAverage` | `number` | Average of all numerical values. NaN otherwise. |
| `qMedian` | `number` | Median of all numerical values. NaN otherwise. |
| `qStd` | `number` | Standard deviation of numerical values. NaN otherwise. |
| `qMin` | `number` | Minimum value of numerical values. NaN otherwise. |
| `qMax` | `number` | Maximum value of numerical values. NaN otherwise. |
| `qSkewness` | `number` | Skewness of the numerical values. NaN otherwise. |
| `qKurtosis` | `number` | Kurtosis of the numerical values. NaN otherwise. |
| `qFractiles` | `array of number` | The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise. |
| `qEmptyStrings` | `integer` | Number of empty strings |
| `qMaxStringLen` | `integer` | Maximum string length of textual values. 0 otherwise. |
| `qMinStringLen` | `integer` | Minimum string length of textual values. 0 otherwise. |
| `qSumStringLen` | `integer` | Sum of all characters in strings in the field |
| `qAvgStringLen` | `number` | Average string length of textual values. 0 otherwise. |
| `qFirstSorted` | `string` | For textual values the first sorted string. |
| `qLastSorted` | `string` | For textual values the last sorted string. |
| `qMostFrequent` | `array` of [SymbolFrequency](#symbolfrequency) | Three most frequent values and their frequencies |
| `qFrequencyDistribution` | [FrequencyDistributionData](#frequencydistributiondata) | |
| `qDataEvenness` | `number` | Data evenness aka Shannon's entropy normalized to [0,1] |
Properties of `qFieldTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qNumberFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
Properties of `qFractiles`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `number` | |
Properties of `qMostFrequent`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SymbolFrequency` | [SymbolFrequency](#symbolfrequency) | |
Properties of `SymbolFrequency`
| Name | Type | Description |
| --- | --- | --- |
| `qSymbol` | [SymbolValue](#symbolvalue) | |
| `qFrequency` | `integer` | Frequency of the above symbol in the field |
Properties of `qSymbol`
_Properties truncated due to depth limit._
Properties of `qFrequencyDistribution`
| Name | Type | Description |
| --- | --- | --- |
| `qNumberOfBins` | `integer` | Number of bins. |
| `qBinsEdges` | `array of number` | Bins edges. |
| `qFrequencies` | `array of integer` | Bins frequencies. |
Properties of `qBinsEdges`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `number` | |
Properties of `qFrequencies`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### FieldList
Lists the fields present in the data model viewer. Is the layout for _FieldListDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxFieldDescription](#nxfielddescription) | Array of items. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxFieldDescription` | [NxFieldDescription](#nxfielddescription) | ### NxDerivedFieldsdata | Name | Description | Type |
| qDerivedDefinitionName | Name of the derived definition. | String |
| qFieldDefs | List of the derived fields. | Array of NxDerivedField |
| qGroupDefs | List of the derived groups. | Array of NxDerivedGroup |
| qTags | List of tags on the derived fields. | Array of String |
|
Properties of `NxFieldDescription`
| Name | Type | Description |
| --- | --- | --- |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qIsHidden` | `boolean` | If set to true, it means that the field is hidden. |
| `qIsSystem` | `boolean` | If set to true, it means that the field is a system field. |
| `qAndMode` | `boolean` | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
| `qName` | `string` | Name of the field |
| `qCardinal` | `integer` | Number of distinct field values |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qIsDefinitionOnly` | `boolean` | If set to true, it means that the field is a field on the fly. |
| `qDerivedFieldData` | [NxDerivedFieldDescriptionList](#nxderivedfielddescriptionlist) | |
| `qIsDetail` | `boolean` | Is used for Direct Discovery. If set to true, it means that the type of the field is detail. |
| `qIsImplicit` | `boolean` | Is used for Direct Discovery. If set to true, it means that the type of the field is measure. |
| `qReadableName` | `string` | |
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qDerivedFieldData`
_Properties truncated due to depth limit._
---
### FieldListDef
Defines the fields to show.
| Name | Type | Description |
| --- | --- | --- |
| `qShowSystem` | `boolean` | Shows the system tables if set to true. Default is false. |
| `qShowHidden` | `boolean` | Shows the hidden fields if set to true. Default is false. |
| `qShowSemantic` | `boolean` | Show the semantic fields if set to true. Default is false. |
| `qShowSrcTables` | `boolean` | Shows the tables and fields present in the data model viewer if set to true. Default is false. |
| `qShowDefinitionOnly` | `boolean` | Shows the fields defined on the fly if set to true. Default is false. |
| `qShowDerivedFields` | `boolean` | Shows the fields and derived fields if set to true. Default is false. |
| `qShowImplicit` | `boolean` | Shows the Direct Discovery measure fields if set to true. Default is false. |
---
### FieldOrColumn
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | Name of the field or column to be matched. |
| `qTableName` | `string` | Name of the table to be matched on. This parameter is optional. If TableName is set, FieldName represent the Table column with that name. If TableName is not set, FieldName represents the the field with that name. |
---
### FieldScores
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | Field name. One of the field names defined in _qFieldPairName._ |
| `qReadableName` | `string` | |
| `qCardinalRatio` | `number` | Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key. |
| `qSymbolScore` | `number` | Number of distinct matches between the two fields defined in _qFieldPairName_ divided by the number of distinct values in the field _qFieldName_ . If 0, it means that there are no common values between the two fields defined in _qFieldPairName_ . |
| `qRowScore` | `number` | Number of matches between the two fields defined in _qFieldPairName_ divided by the number of values in the field _qFieldName_ . If 0, it means that there are no common values between the two fields defined in _qFieldPairName_ . |
---
### FieldType
| Name | Type | Description |
| --- | --- | --- |
| `FieldType` | oneOf(NOT_PRESENT \| PRESENT \| IS_CYCLIC_GROUP \| IS_DRILL_GROUP \| IS_VAR \| IS_EXPR \| IS_IMPLICIT \| IS_DETAIL) | |
Properties of `FieldType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT_PRESENT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `PRESENT` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_CYCLIC_GROUP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_DRILL_GROUP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_VAR` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_EXPR` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_IMPLICIT` | `object` | |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `IS_DETAIL` | `object` | |
---
### FieldValue
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
---
### FileDataFormat
**FileType**
Recognized file formats are:
* _CSV_ for Delimited
* _FIX_ for Fixed Record
* _DIF_ for Data Interchange Format
* _EXCEL_BIFF_ for Microsoft Excel (XLS)
* _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* _HTML_ for HTML
* _QVD_ for QVD file
* _XML_ for XML
* _QVX_ for QVX file
* _JSON_ for JSON format
* _KML_ for KML file
* _PARQUET_ for PARQUET file
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(CSV \| FIX \| DIF \| EXCEL_BIFF \| EXCEL_OOXML \| HTML \| QVD \| XML \| QVX \| JSON \| KML \| PARQUET) | |
| `qLabel` | `string` | One of: * Embedded labels (field names are present in the file) * No labels * Explicit labels (for DIFfiles) |
| `qQuote` | `string` | One of: * None (no quotes) * MSQ (Modern Style Quoting) * Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value) This property is used for delimited files. |
| `qComment` | `string` | String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files. |
| `qDelimiter` | [DelimiterInfo](#delimiterinfo) | |
| `qCodePage` | `integer` | Character set used in the file. |
| `qHeaderSize` | `integer` | Size of the header. Example: If the header size is 2, the first two rows in the file are considered as header and not as data. The header can contain the field names. |
| `qRecordSize` | `integer` | Record length. Each record (row of data) contains a number of columns with a fixed field size. This property is used for fixed record data files. |
| `qTabSize` | `integer` | Number of spaces that one tab character represents in the table file. This property is used for fixed record data files. |
| `qIgnoreEOF` | `boolean` | Is set to true, the end-of-file character is not taken into account during reload. This property is used for delimited files and fixed record data files. |
| `qFixedWidthDelimiters` | `string` | Positions of the field breaks in the table. This property is used for fixed record data files. |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `CSV` | `object` | FILE_TYPE_CSV |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FIX` | `object` | FILE_TYPE_FIX |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DIF` | `object` | FILE_TYPE_DIF |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `EXCEL_BIFF` | `object` | FILE_TYPE_EXCEL_BIFF |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `EXCEL_OOXML` | `object` | FILE_TYPE_EXCEL_OOXML |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `HTML` | `object` | FILE_TYPE_HTML |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `QVD` | `object` | FILE_TYPE_QVD |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `XML` | `object` | FILE_TYPE_XML |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `QVX` | `object` | FILE_TYPE_QVX |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `JSON` | `object` | FILE_TYPE_JSON |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `KML` | `object` | FILE_TYPE_KML |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `PARQUET` | `object` | FILE_TYPE_PARQUET |
Properties of `qDelimiter`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the delimiter. Example: "Tab_DELIMITER" |
| `qScriptCode` | `string` | Representation of the delimiter value that is used in the script. Example: "'\t'" |
| `qNumber` | `integer` | Delimiter character number used by the engine to determine how to separate the values. |
| `qIsMultiple` | `boolean` | Is set to true if multiple spaces are used to separate the values. |
---
### FileType
| Name | Type | Description |
| --- | --- | --- |
| `FileType` | oneOf(CSV \| FIX \| DIF \| EXCEL_BIFF \| EXCEL_OOXML \| HTML \| QVD \| XML \| QVX \| JSON \| KML \| PARQUET) | |
Properties of `FileType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `CSV` | `object` | FILE_TYPE_CSV |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FIX` | `object` | FILE_TYPE_FIX |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DIF` | `object` | FILE_TYPE_DIF |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `EXCEL_BIFF` | `object` | FILE_TYPE_EXCEL_BIFF |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `EXCEL_OOXML` | `object` | FILE_TYPE_EXCEL_OOXML |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `HTML` | `object` | FILE_TYPE_HTML |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `QVD` | `object` | FILE_TYPE_QVD |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `XML` | `object` | FILE_TYPE_XML |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `QVX` | `object` | FILE_TYPE_QVX |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `JSON` | `object` | FILE_TYPE_JSON |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `KML` | `object` | FILE_TYPE_KML |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `PARQUET` | `object` | FILE_TYPE_PARQUET |
---
### FilterInfo
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(NONE \| RAW) | |
| `qWherePredicate` | `string` | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NONE` | `object` | FILTER_TYPE_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `RAW` | `object` | FILTER_TYPE_RAW |
---
### FilterType
| Name | Type | Description |
| --- | --- | --- |
| `FilterType` | oneOf(NONE \| RAW) | |
Properties of `FilterType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NONE` | `object` | FILTER_TYPE_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `RAW` | `object` | FILTER_TYPE_RAW |
---
### FolderItem
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the folder item. |
| `qType` | oneOf(FOLDER \| FILE \| OTHER) | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `FOLDER` | `object` | FOLDER_ITEM_FOLDER |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FILE` | `object` | FOLDER_ITEM_FILE |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER` | `object` | FOLDER_ITEM_OTHER |
---
### FolderItemType
| Name | Type | Description |
| --- | --- | --- |
| `FolderItemType` | oneOf(FOLDER \| FILE \| OTHER) | |
Properties of `FolderItemType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `FOLDER` | `object` | FOLDER_ITEM_FOLDER |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FILE` | `object` | FOLDER_ITEM_FILE |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER` | `object` | FOLDER_ITEM_OTHER |
---
### FrequencyDistributionData
| Name | Type | Description |
| --- | --- | --- |
| `qNumberOfBins` | `integer` | Number of bins. |
| `qBinsEdges` | `array of number` | Bins edges. |
| `qFrequencies` | `array of integer` | Bins frequencies. |
Properties of `qBinsEdges`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `number` | |
Properties of `qFrequencies`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### Function
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the script function. |
| `qGroup` | oneOf(ALL \| U \| NONE \| AGGR \| NUM \| RNG \| EXP \| TRIG \| FIN \| MATH \| COUNT \| STR \| MAPP \| RCRD \| CND \| LOG \| NULL \| SYS \| FILE \| TBL \| DATE \| NUMI \| FRMT \| CLR \| RNK \| GEO \| EXT \| PROB \| ARRAY \| LEG \| DB \| WINDOW) | |
| `qSignature` | `string` | Signature of the script function. Gives general information about the function. |
Properties of `qGroup`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ALL` | `object` | FUNC_GROUP_ALL |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | FUNC_GROUP_UNKNOWN |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `NONE` | `object` | FUNC_GROUP_NONE |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `AGGR` | `object` | FUNC_GROUP_AGGR |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `NUM` | `object` | FUNC_GROUP_NUMERIC |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `RNG` | `object` | FUNC_GROUP_RANGE |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `EXP` | `object` | FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `TRIG` | `object` | FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `FIN` | `object` | FUNC_GROUP_FINANCIAL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `MATH` | `object` | FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `COUNT` | `object` | FUNC_GROUP_COUNTER |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `STR` | `object` | FUNC_GROUP_STRING |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `MAPP` | `object` | FUNC_GROUP_MAPPING |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `RCRD` | `object` | FUNC_GROUP_INTER_RECORD |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `CND` | `object` | FUNC_GROUP_CONDITIONAL |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG` | `object` | FUNC_GROUP_LOGICAL |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `NULL` | `object` | FUNC_GROUP_NULL |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `SYS` | `object` | FUNC_GROUP_SYSTEM |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `FILE` | `object` | FUNC_GROUP_FILE |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `TBL` | `object` | FUNC_GROUP_TABLE |
**Option 21:**
| Name | Type | Description |
| --- | --- | --- |
| `DATE` | `object` | FUNC_GROUP_DATE_AND_TIME |
**Option 22:**
| Name | Type | Description |
| --- | --- | --- |
| `NUMI` | `object` | FUNC_GROUP_NUMBER_INTERPRET |
**Option 23:**
| Name | Type | Description |
| --- | --- | --- |
| `FRMT` | `object` | FUNC_GROUP_FORMATTING |
**Option 24:**
| Name | Type | Description |
| --- | --- | --- |
| `CLR` | `object` | FUNC_GROUP_COLOR |
**Option 25:**
| Name | Type | Description |
| --- | --- | --- |
| `RNK` | `object` | FUNC_GROUP_RANKING |
**Option 26:**
| Name | Type | Description |
| --- | --- | --- |
| `GEO` | `object` | FUNC_GROUP_GEO |
**Option 27:**
| Name | Type | Description |
| --- | --- | --- |
| `EXT` | `object` | FUNC_GROUP_EXTERNAL |
**Option 28:**
| Name | Type | Description |
| --- | --- | --- |
| `PROB` | `object` | FUNC_GROUP_PROBABILITY |
**Option 29:**
| Name | Type | Description |
| --- | --- | --- |
| `ARRAY` | `object` | FUNC_GROUP_ARRAY |
**Option 30:**
| Name | Type | Description |
| --- | --- | --- |
| `LEG` | `object` | FUNC_GROUP_LEGACY |
**Option 31:**
| Name | Type | Description |
| --- | --- | --- |
| `DB` | `object` | FUNC_GROUP_DB_NATIVE |
**Option 32:**
| Name | Type | Description |
| --- | --- | --- |
| `WINDOW` | `object` | FUNC_GROUP_WINDOW |
---
### FunctionGroup
| Name | Type | Description |
| --- | --- | --- |
| `FunctionGroup` | oneOf(ALL \| U \| NONE \| AGGR \| NUM \| RNG \| EXP \| TRIG \| FIN \| MATH \| COUNT \| STR \| MAPP \| RCRD \| CND \| LOG \| NULL \| SYS \| FILE \| TBL \| DATE \| NUMI \| FRMT \| CLR \| RNK \| GEO \| EXT \| PROB \| ARRAY \| LEG \| DB \| WINDOW) | |
Properties of `FunctionGroup`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ALL` | `object` | FUNC_GROUP_ALL |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | FUNC_GROUP_UNKNOWN |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `NONE` | `object` | FUNC_GROUP_NONE |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `AGGR` | `object` | FUNC_GROUP_AGGR |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `NUM` | `object` | FUNC_GROUP_NUMERIC |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `RNG` | `object` | FUNC_GROUP_RANGE |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `EXP` | `object` | FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `TRIG` | `object` | FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `FIN` | `object` | FUNC_GROUP_FINANCIAL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `MATH` | `object` | FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `COUNT` | `object` | FUNC_GROUP_COUNTER |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `STR` | `object` | FUNC_GROUP_STRING |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `MAPP` | `object` | FUNC_GROUP_MAPPING |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `RCRD` | `object` | FUNC_GROUP_INTER_RECORD |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `CND` | `object` | FUNC_GROUP_CONDITIONAL |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG` | `object` | FUNC_GROUP_LOGICAL |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `NULL` | `object` | FUNC_GROUP_NULL |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `SYS` | `object` | FUNC_GROUP_SYSTEM |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `FILE` | `object` | FUNC_GROUP_FILE |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `TBL` | `object` | FUNC_GROUP_TABLE |
**Option 21:**
| Name | Type | Description |
| --- | --- | --- |
| `DATE` | `object` | FUNC_GROUP_DATE_AND_TIME |
**Option 22:**
| Name | Type | Description |
| --- | --- | --- |
| `NUMI` | `object` | FUNC_GROUP_NUMBER_INTERPRET |
**Option 23:**
| Name | Type | Description |
| --- | --- | --- |
| `FRMT` | `object` | FUNC_GROUP_FORMATTING |
**Option 24:**
| Name | Type | Description |
| --- | --- | --- |
| `CLR` | `object` | FUNC_GROUP_COLOR |
**Option 25:**
| Name | Type | Description |
| --- | --- | --- |
| `RNK` | `object` | FUNC_GROUP_RANKING |
**Option 26:**
| Name | Type | Description |
| --- | --- | --- |
| `GEO` | `object` | FUNC_GROUP_GEO |
**Option 27:**
| Name | Type | Description |
| --- | --- | --- |
| `EXT` | `object` | FUNC_GROUP_EXTERNAL |
**Option 28:**
| Name | Type | Description |
| --- | --- | --- |
| `PROB` | `object` | FUNC_GROUP_PROBABILITY |
**Option 29:**
| Name | Type | Description |
| --- | --- | --- |
| `ARRAY` | `object` | FUNC_GROUP_ARRAY |
**Option 30:**
| Name | Type | Description |
| --- | --- | --- |
| `LEG` | `object` | FUNC_GROUP_LEGACY |
**Option 31:**
| Name | Type | Description |
| --- | --- | --- |
| `DB` | `object` | FUNC_GROUP_DB_NATIVE |
**Option 32:**
| Name | Type | Description |
| --- | --- | --- |
| `WINDOW` | `object` | FUNC_GROUP_WINDOW |
---
### GenericBookmarkEntry
| Name | Type | Description |
| --- | --- | --- |
| `qProperties` | [GenericBookmarkProperties](#genericbookmarkproperties) | |
| `qBookmark` | [NxBookmark](#nxbookmark) | |
| `qClassicBookmark` | [Bookmark](#bookmark) | |
| `qClassicMetadata` | [MetaData](#metadata) | |
Properties of `qProperties`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qIncludeVariables` | `boolean` | If true all variables will be stored in the bookmark. |
| `qDistinctValues` | `boolean` | If true all selected values will be stored distinct, i.e. searchstrings will not be kept. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qBookmark`
| Name | Type | Description |
| --- | --- | --- |
| `qStateData` | `array` of [AlternateStateData](#alternatestatedata) | List of selections for each state. |
| `qUtcModifyTime` | `number` | Time when the bookmark was created. |
| `qVariableItems` | `array` of [BookmarkVariableItem](#bookmarkvariableitem) | List of the variables in the app at the time the bookmark was created. |
| `qPatches` | `array` of [NxPatches](#nxpatches) | Softpatches to be applied with this bookmark. |
| `qCyclicGroupStates` | `array` of [CyclicGroupPosition](#cyclicgroupposition) | Information about cyclic groups by zero-based index. This field is unused. |
| `qGroupStates` | `array` of [GroupState](#groupstate) | Information about cyclic groups indexed by field definition. |
Properties of `qStateData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `AlternateStateData` | [AlternateStateData](#alternatestatedata) | |
Properties of `AlternateStateData`
_Properties truncated due to depth limit._
Properties of `qVariableItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkVariableItem` | [BookmarkVariableItem](#bookmarkvariableitem) | |
Properties of `BookmarkVariableItem`
_Properties truncated due to depth limit._
Properties of `qPatches`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPatches` | [NxPatches](#nxpatches) | |
Properties of `NxPatches`
_Properties truncated due to depth limit._
Properties of `qCyclicGroupStates`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `CyclicGroupPosition` | [CyclicGroupPosition](#cyclicgroupposition) | |
Properties of `CyclicGroupPosition`
_Properties truncated due to depth limit._
Properties of `qGroupStates`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GroupState` | [GroupState](#groupstate) | |
Properties of `GroupState`
_Properties truncated due to depth limit._
Properties of `qClassicBookmark`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qName` | `string` | |
| `qUtcModifyTime` | `number` | |
| `qUtcRecallTime` | `number` | |
| `qRecallCount` | `integer` | |
| `qApplyAdditive` | `boolean` | |
| `qFieldItems` | `array` of [BookmarkFieldItem](#bookmarkfielditem) | |
| `qVariableItems` | `array` of [BookmarkVariableItem](#bookmarkvariableitem) | |
| `qSheetId` | `string` | |
| `qObjects` | `array` of [LayoutBookmarkData](#layoutbookmarkdata) | |
| `qApplyLayoutState` | `boolean` | |
| `qShowPopupInfo` | `boolean` | |
| `qInfoText` | `string` | |
| `qOwner` | `string` | |
| `qGroups` | `array` of [GroupBookmarkData](#groupbookmarkdata) | |
| `qShow` | [CondDef](#conddef) | |
| `qApplyInputFieldValues` | `boolean` | |
| `qInputFieldItems` | `array` of [InputFieldItem](#inputfielditem) | |
| `qObjectsLayout` | `array` of [ExtendedLayoutBookmarkData](#extendedlayoutbookmarkdata) | |
| `qIncludeSelectionState` | `boolean` | |
| `qIncludeScrollPosition` | `boolean` | |
| `qAlternateStateData` | `array` of [AlternateStateData](#alternatestatedata) | |
| `qForAnnotations` | `boolean` | |
| `qIncludeAllVariables` | `boolean` | |
Properties of `qFieldItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkFieldItem` | [BookmarkFieldItem](#bookmarkfielditem) | |
Properties of `BookmarkFieldItem`
_Properties truncated due to depth limit._
Properties of `qVariableItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkVariableItem` | [BookmarkVariableItem](#bookmarkvariableitem) | |
Properties of `BookmarkVariableItem`
_Properties truncated due to depth limit._
Properties of `qObjects`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `LayoutBookmarkData` | [LayoutBookmarkData](#layoutbookmarkdata) | |
Properties of `LayoutBookmarkData`
_Properties truncated due to depth limit._
Properties of `qGroups`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GroupBookmarkData` | [GroupBookmarkData](#groupbookmarkdata) | |
Properties of `GroupBookmarkData`
_Properties truncated due to depth limit._
Properties of `qShow`
| Name | Type | Description |
| --- | --- | --- |
| `qAlways` | `boolean` | |
| `qExpression` | [ValueExpr](#valueexpr) | |
Properties of `qExpression`
_Properties truncated due to depth limit._
Properties of `qInputFieldItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `InputFieldItem` | [InputFieldItem](#inputfielditem) | |
Properties of `InputFieldItem`
_Properties truncated due to depth limit._
Properties of `qObjectsLayout`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ExtendedLayoutBookmarkData` | [ExtendedLayoutBookmarkData](#extendedlayoutbookmarkdata) | |
Properties of `ExtendedLayoutBookmarkData`
_Properties truncated due to depth limit._
Properties of `qAlternateStateData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `AlternateStateData` | [AlternateStateData](#alternatestatedata) | |
Properties of `AlternateStateData`
_Properties truncated due to depth limit._
Properties of `qClassicMetadata`
| Name | Type | Description |
| --- | --- | --- |
| `qShared` | `boolean` | |
| `qUtcModifyTime` | `number` | |
| `qSheetId` | `string` | |
| `qTemporary` | `boolean` | |
| `qRestrictedAccess` | `boolean` | |
| `qAccessList` | `array of string` | |
| `qPersonalEditionHash_OBSOLETE` | `string` | |
| `qHidden` | `boolean` | |
| `qLinkedTo` | `array of string` | |
Properties of `qAccessList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qLinkedTo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### GenericBookmarkLayout
Is the layout for _GenericBookmarkProperties_.
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qBookmark` | [NxBookmark](#nxbookmark) | |
| `qFieldInfos` | `array` of [LayoutFieldInfo](#layoutfieldinfo) | Information about the field selections associated with the bookmark. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qBookmark`
| Name | Type | Description |
| --- | --- | --- |
| `qStateData` | `array` of [AlternateStateData](#alternatestatedata) | List of selections for each state. |
| `qUtcModifyTime` | `number` | Time when the bookmark was created. |
| `qVariableItems` | `array` of [BookmarkVariableItem](#bookmarkvariableitem) | List of the variables in the app at the time the bookmark was created. |
| `qPatches` | `array` of [NxPatches](#nxpatches) | Softpatches to be applied with this bookmark. |
| `qCyclicGroupStates` | `array` of [CyclicGroupPosition](#cyclicgroupposition) | Information about cyclic groups by zero-based index. This field is unused. |
| `qGroupStates` | `array` of [GroupState](#groupstate) | Information about cyclic groups indexed by field definition. |
Properties of `qStateData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `AlternateStateData` | [AlternateStateData](#alternatestatedata) | |
Properties of `AlternateStateData`
_Properties truncated due to depth limit._
Properties of `qVariableItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkVariableItem` | [BookmarkVariableItem](#bookmarkvariableitem) | |
Properties of `BookmarkVariableItem`
_Properties truncated due to depth limit._
Properties of `qPatches`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPatches` | [NxPatches](#nxpatches) | |
Properties of `NxPatches`
_Properties truncated due to depth limit._
Properties of `qCyclicGroupStates`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `CyclicGroupPosition` | [CyclicGroupPosition](#cyclicgroupposition) | |
Properties of `CyclicGroupPosition`
_Properties truncated due to depth limit._
Properties of `qGroupStates`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GroupState` | [GroupState](#groupstate) | |
Properties of `GroupState`
_Properties truncated due to depth limit._
Properties of `qFieldInfos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `LayoutFieldInfo` | [LayoutFieldInfo](#layoutfieldinfo) | Meta data about the selection in a field. |
Properties of `LayoutFieldInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | The name of the field. |
| `qValuesCount` | `integer` | Number of selected values in the field. |
| `qExcludedValuesCount` | `integer` | Number of excluded values in the field. |
---
### GenericBookmarkProperties
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qIncludeVariables` | `boolean` | If true all variables will be stored in the bookmark. |
| `qDistinctValues` | `boolean` | If true all selected values will be stored distinct, i.e. searchstrings will not be kept. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### GenericConnectMachine
| Name | Type | Description |
| --- | --- | --- |
| `GenericConnectMachine` | oneOf(CONNECT_DEFAULT \| CONNECT_64 \| CONNECT_32) | |
Properties of `GenericConnectMachine`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `CONNECT_DEFAULT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `CONNECT_64` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `CONNECT_32` | `object` | |
---
### GenericDimensionInfo
| Name | Type | Description |
| --- | --- | --- |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qAndMode` | `boolean` | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### GenericDimensionLayout
Is the layout for _GenericDimensionProperties_.
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qDim` | [NxLibraryDimension](#nxlibrarydimension) | |
| `qDimInfos` | `array` of [GenericDimensionInfo](#genericdimensioninfo) | Cardinal and tags related to the dimension. Length of the longest value in the field. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qDim`
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of dimension names. |
| `qFieldLabels` | `array of string` | Array of dimension labels. |
| `qLabelExpression` | `string` | |
| `qAlias` | `string` | Alias of the dimension. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qDimInfos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericDimensionInfo` | [GenericDimensionInfo](#genericdimensioninfo) | |
Properties of `GenericDimensionInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qAndMode` | `boolean` | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
---
### GenericDimensionProperties
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qDim` | [NxLibraryDimensionDef](#nxlibrarydimensiondef) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qDim`
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of dimension names. |
| `qFieldLabels` | `array of string` | Array of dimension labels. |
| `qLabelExpression` | `string` | |
| `qAlias` | `string` | Alias of the dimension. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### GenericMeasureLayout
Is the layout for _GenericMeasureProperties_.
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeasure` | [NxLibraryMeasure](#nxlibrarymeasure) | Information about the library measure. Is the layout for _NxLibraryMeasureDef_. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeasure`
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | |
| `qDef` | `string` | |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qExpressions` | `array of string` | |
| `qActiveExpression` | `integer` | |
| `qLabelExpression` | `string` | |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### GenericMeasureProperties
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeasure` | [NxLibraryMeasureDef](#nxlibrarymeasuredef) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeasure`
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | Label of the measure. |
| `qDef` | `string` | Definition of the measure. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qExpressions` | `array of string` | Array of expressions. |
| `qActiveExpression` | `integer` | Index to the active expression in a measure. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
---
### GenericObjectEntry
| Name | Type | Description |
| --- | --- | --- |
| `qProperty` | [GenericObjectProperties](#genericobjectproperties) | |
| `qChildren` | `array` of [GenericObjectEntry](#genericobjectentry) | Information about the children of the generic object. |
| `qEmbeddedSnapshotRef` | [GenericBookmarkEntry](#genericbookmarkentry) | |
Properties of `qProperty`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qExtendsId` | `string` | Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string. |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qChildren`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericObjectEntry` | [GenericObjectEntry](#genericobjectentry) | |
Properties of `GenericObjectEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qProperty` | [GenericObjectProperties](#genericobjectproperties) | |
| `qChildren` | `array` of [GenericObjectEntry](#genericobjectentry) | Information about the children of the generic object. |
| `qEmbeddedSnapshotRef` | [GenericBookmarkEntry](#genericbookmarkentry) | |
Properties of `qProperty`
_Properties truncated due to depth limit._
Properties of `qChildren`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qEmbeddedSnapshotRef`
_Properties truncated due to depth limit._
Properties of `qEmbeddedSnapshotRef`
| Name | Type | Description |
| --- | --- | --- |
| `qProperties` | [GenericBookmarkProperties](#genericbookmarkproperties) | |
| `qBookmark` | [NxBookmark](#nxbookmark) | |
| `qClassicBookmark` | [Bookmark](#bookmark) | |
| `qClassicMetadata` | [MetaData](#metadata) | |
Properties of `qProperties`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qIncludeVariables` | `boolean` | If true all variables will be stored in the bookmark. |
| `qDistinctValues` | `boolean` | If true all selected values will be stored distinct, i.e. searchstrings will not be kept. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qBookmark`
| Name | Type | Description |
| --- | --- | --- |
| `qStateData` | `array` of [AlternateStateData](#alternatestatedata) | List of selections for each state. |
| `qUtcModifyTime` | `number` | Time when the bookmark was created. |
| `qVariableItems` | `array` of [BookmarkVariableItem](#bookmarkvariableitem) | List of the variables in the app at the time the bookmark was created. |
| `qPatches` | `array` of [NxPatches](#nxpatches) | Softpatches to be applied with this bookmark. |
| `qCyclicGroupStates` | `array` of [CyclicGroupPosition](#cyclicgroupposition) | Information about cyclic groups by zero-based index. This field is unused. |
| `qGroupStates` | `array` of [GroupState](#groupstate) | Information about cyclic groups indexed by field definition. |
Properties of `qStateData`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qVariableItems`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qPatches`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCyclicGroupStates`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qGroupStates`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qClassicBookmark`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qName` | `string` | |
| `qUtcModifyTime` | `number` | |
| `qUtcRecallTime` | `number` | |
| `qRecallCount` | `integer` | |
| `qApplyAdditive` | `boolean` | |
| `qFieldItems` | `array` of [BookmarkFieldItem](#bookmarkfielditem) | |
| `qVariableItems` | `array` of [BookmarkVariableItem](#bookmarkvariableitem) | |
| `qSheetId` | `string` | |
| `qObjects` | `array` of [LayoutBookmarkData](#layoutbookmarkdata) | |
| `qApplyLayoutState` | `boolean` | |
| `qShowPopupInfo` | `boolean` | |
| `qInfoText` | `string` | |
| `qOwner` | `string` | |
| `qGroups` | `array` of [GroupBookmarkData](#groupbookmarkdata) | |
| `qShow` | [CondDef](#conddef) | |
| `qApplyInputFieldValues` | `boolean` | |
| `qInputFieldItems` | `array` of [InputFieldItem](#inputfielditem) | |
| `qObjectsLayout` | `array` of [ExtendedLayoutBookmarkData](#extendedlayoutbookmarkdata) | |
| `qIncludeSelectionState` | `boolean` | |
| `qIncludeScrollPosition` | `boolean` | |
| `qAlternateStateData` | `array` of [AlternateStateData](#alternatestatedata) | |
| `qForAnnotations` | `boolean` | |
| `qIncludeAllVariables` | `boolean` | |
Properties of `qFieldItems`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qVariableItems`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qObjects`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qGroups`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qShow`
_Properties truncated due to depth limit._
Properties of `qInputFieldItems`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qObjectsLayout`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAlternateStateData`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qClassicMetadata`
| Name | Type | Description |
| --- | --- | --- |
| `qShared` | `boolean` | |
| `qUtcModifyTime` | `number` | |
| `qSheetId` | `string` | |
| `qTemporary` | `boolean` | |
| `qRestrictedAccess` | `boolean` | |
| `qAccessList` | `array of string` | |
| `qPersonalEditionHash_OBSOLETE` | `string` | |
| `qHidden` | `boolean` | |
| `qLinkedTo` | `array of string` | |
Properties of `qAccessList`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qLinkedTo`
**Array items:**
_Properties truncated due to depth limit._
---
### GenericObjectLayout
Is the layout for _GenericObjectProperties_.
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qExtendsId` | `string` | Should be set to create an object that is linked to another object. Enter the identifier of the object you want to link to. If you do not want to link your object, set this parameter to an empty string. |
| `qHasSoftPatches` | `boolean` | Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied). |
| `qError` | [NxLayoutErrors](#nxlayouterrors) | |
| `qSelectionInfo` | [NxSelectionInfo](#nxselectioninfo) | |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. |
Properties of `qSelectionInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qInSelections` | `boolean` | Is set to true if the visualization is in selection mode. For more information about the selection mode, see _BeginSelections Method_. |
| `qMadeSelections` | `boolean` | Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see _BeginSelections Method_. |
---
### GenericObjectProperties
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qExtendsId` | `string` | Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string. |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### GenericVariableConstraints
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(any \| number \| text) | |
| `qValuesText` | `array of string` | |
| `qValuesNum` | `array of number` | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `any` | `object` | VARIABLE_TYPE_ANY |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `number` | `object` | VARIABLE_TYPE_NUMBER |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `text` | `object` | VARIABLE_TYPE_TEXT |
Properties of `qValuesText`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qValuesNum`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `number` | |
---
### GenericVariableLayout
Is the layout for _GenericVariableProperties_.
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qText` | `string` | Some text. |
| `qNum` | `number` | A value. |
| `qIsScriptCreated` | `boolean` | If set to true, it means that the variable was defined via script. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### GenericVariableProperties
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMetaDef` | [NxMetaDef](#nxmetadef) | Used to collect meta data. ### Properties Semantic type with an empty structure. |
| `qName` | `string` | Name of the variable. The name must be unique. This parameter is mandatory. |
| `qComment` | `string` | Comment related to the variable. This parameter is optional. |
| `qNumberPresentation` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIncludeInBookmark` | `boolean` | Set this property to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark. The value of a variable can affect the state of the selections. Script variables cannot be persisted in the bookmark. The default value is false. |
| `qDefinition` | `string` | Definition of the variable. |
| `qConstraints` | [GenericVariableConstraints](#genericvariableconstraints) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qNumberPresentation`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
Properties of `qConstraints`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(any \| number \| text) | |
| `qValuesText` | `array of string` | |
| `qValuesNum` | `array of number` | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `any` | `object` | VARIABLE_TYPE_ANY |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `number` | `object` | VARIABLE_TYPE_NUMBER |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `text` | `object` | VARIABLE_TYPE_TEXT |
Properties of `qValuesText`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qValuesNum`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `number` | |
---
### GenericVariableType
| Name | Type | Description |
| --- | --- | --- |
| `GenericVariableType` | oneOf(any \| number \| text) | |
Properties of `GenericVariableType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `any` | `object` | VARIABLE_TYPE_ANY |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `number` | `object` | VARIABLE_TYPE_NUMBER |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `text` | `object` | VARIABLE_TYPE_TEXT |
---
### GraphMode
| Name | Type | Description |
| --- | --- | --- |
| `GraphMode` | oneOf(GRAPH_MODE_BAR \| GRAPH_MODE_PIE \| GRAPH_MODE_PIVOTTABLE \| GRAPH_MODE_SCATTER \| GRAPH_MODE_LINE \| GRAPH_MODE_STRAIGHTTABLE \| GRAPH_MODE_COMBO \| GRAPH_MODE_RADAR \| GRAPH_MODE_GAUGE \| GRAPH_MODE_GRID \| GRAPH_MODE_BLOCK \| GRAPH_MODE_FUNNEL \| GRAPH_MODE_MEKKO \| GRAPH_MODE_LAST) | |
Properties of `GraphMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_BAR` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_PIE` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_PIVOTTABLE` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_SCATTER` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_LINE` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_STRAIGHTTABLE` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_COMBO` | `object` | |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_RADAR` | `object` | |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_GAUGE` | `object` | |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_GRID` | `object` | |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_BLOCK` | `object` | |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_FUNNEL` | `object` | |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_MEKKO` | `object` | |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `GRAPH_MODE_LAST` | `object` | |
---
### GroupBookmarkData
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qCyclePos` | `integer` | |
---
### GroupState
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qActiveFieldDef` | `string` | String defining the active field. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### GroupStateInfo
| Name | Type | Description |
| --- | --- | --- |
| `qGroupName` | `string` | |
| `qCurrentItemName` | `string` | |
---
### HyperCube
Renders the properties of a hypercube. Is the layout for _HyperCubeDef_.
For more information about the definition of a hypercube, see _Generic object_.
What is returned in HyperCube depends on the type of the hypercube (straight, pivot or stacked table, or tree) and on the method called (GetLayout, GetHyperCubeData, GetHyperCubePivotData, GetHyperCubeStackData, GetHyperCubeTreeData).
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
| `qSize` | [Size](#size) | |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qDimensionInfo` | `array` of [NxDimensionInfo](#nxdimensioninfo) | Information on the dimension. |
| `qMeasureInfo` | `array` of [NxMeasureInfo](#nxmeasureinfo) | Information on the measure. |
| `qEffectiveInterColumnSortOrder` | `array of integer` | Sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted was the column 1, followed by the column 0 and the column 2. |
| `qGrandTotalRow` | `array` of [NxCell](#nxcell) | Aggregate for measures of all values in the field. The result value depends on the _qAggrFunc_ defined in _HyperCubeDef_. |
| `qDataPages` | `array` of [NxDataPage](#nxdatapage) | Set of data. Is empty if nothing has been defined in **qInitialDataFetch** in _HyperCubeDef_. |
| `qPivotDataPages` | `array` of [NxPivotPage](#nxpivotpage) | Set of data for pivot tables. Is empty if nothing has been defined in **qInitialDataFetch** in _HyperCubeDef_. |
| `qStackedDataPages` | `array` of [NxStackPage](#nxstackpage) | Set of data for stacked tables. Is empty if nothing has been defined in **qInitialDataFetch** in _HyperCubeDef_. |
| `qMode` | oneOf(S \| P \| K \| T \| D) | |
| `qNoOfLeftDims` | `integer` | Number of left dimensions. Default value is -1. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with: * Four dimensions in the following order: Country, City, Product and Category * One pseudo dimension in position 1 * Three left dimensions. implies that: * The index 0 corresponds to the left dimension Country. * The index 1 corresponds to the pseudo dimension. * The index 2 corresponds to the left dimension City. * Product and Category are top dimensions. Another example: * Four dimensions in the following order: Country, City, Product and Category. * One pseudo dimension in position -1. * Three left dimensions. implies that: * The index -1 corresponds to the pseudo dimension; the pseudo dimension is the most to the right. * The index 0 corresponds to the left dimension Country. * The index 1 corresponds to the left dimension City. * The index 2 corresponds to the left dimension Product. * Category is a top dimension. |
| `qIndentMode` | `boolean` | Is used for pivot tables only. If set to true, the formatting of the results is slightly different. This property is optional. |
| `qLastExpandedPos` | [NxCellPosition](#nxcellposition) | |
| `qHasOtherValues` | `boolean` | True if other row exists. |
| `qTitle` | `string` | Title of the hypercube, for example the title of a chart. |
| `qTreeNodesOnDim` | `array of integer` | The total number of nodes on each dimension (only applicable when _qMode = T_ ). |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qColumnOrder` | `array of integer` | The order of the columns. |
Properties of `qSize`
| Name | Type | Description |
| --- | --- | --- |
| `qcx` | `integer` | Number of pixels on the _x_ axis. |
| `qcy` | `integer` | Number of pixels on the _y_ axis. |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
Properties of `qDimensionInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDimensionInfo` | [NxDimensionInfo](#nxdimensioninfo) | |
Properties of `NxDimensionInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qLocked` | `boolean` | Is set to true if the field is locked. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qGroupFallbackTitles` | `array of string` | Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group). |
| `qGroupPos` | `integer` | Index of the dimension that is currently in use. _qGroupPos_ is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups. |
| `qStateCounts` | [NxStateCounts](#nxstatecounts) | |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qDimensionType` | oneOf(D \| N \| T) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's definition. |
| `qGroupFieldDefs` | `array of string` | Array of field names. |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qContinuousAxes` | `boolean` | Is continuous axis used. |
| `qIsCyclic` | `boolean` | Is a cyclic dimension used. |
| `qDerivedField` | `boolean` | Is derived field is used as a dimension. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | Array of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | Array of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
| `qIsOneAndOnlyOne` | `boolean` | If set to true, it means that the field always has one and only one selected value. |
| `qCardinalities` | [NxCardinalities](#nxcardinalities) | |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qEffectiveDimensionName` | `string` | The expanded and stripped dimension name used internally in engine. |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qGroupFallbackTitles`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qStateCounts`
_Properties truncated due to depth limit._
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qDimensionType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qGrouping`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qGroupFieldDefs`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExprInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCardinalities`
_Properties truncated due to depth limit._
Properties of `qMeasureInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMeasureInfo` | [NxMeasureInfo](#nxmeasureinfo) | Layout for _NxInlineMeasureDef_. |
Properties of `NxMeasureInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the measure. If the label is not defined then the measure name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qMin` | `number` | Lowest value in the range. |
| `qMax` | `number` | Highest value in the range. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | List of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | List of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qTrendLines` | `array` of [NxTrendline](#nxtrendline) | Calculated trendlines |
| `qMiniChart` | [NxMiniChart](#nxminichart) | |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qAttrExprInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTrendLines`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMiniChart`
_Properties truncated due to depth limit._
Properties of `qEffectiveInterColumnSortOrder`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qGrandTotalRow`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxCell` | [NxCell](#nxcell) | |
Properties of `NxCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. This parameter is optional. |
| `qNum` | `number` | A value. This parameter is optional. |
| `qElemNumber` | `integer` | Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values: * -1: the cell is a _Total_ cell. It shows a total. * -2: the cell is a _Null_ cell. * -3: the cell belongs to the group _Others_ . * -4: the cell is empty. Applies to pivot tables. |
| `qState` | oneOf(L \| S \| O \| D \| A \| X \| XS \| XL \| NSTATES) | |
| `qIsEmpty` | `boolean` | Is set to _true_ , if **qText** and **qNum** are empty. This parameter is optional. The default value is _false_ . |
| `qIsTotalCell` | `boolean` | Is set to _true_ if a total is displayed in the cell. This parameter is optional. The default value is _false_ . Not applicable to list objects. |
| `qIsOtherCell` | `boolean` | Is set to _true_ if the cell belongs to the group _Others_ . Dimension values can be set as _Others_ depending on what has been defined in **OtherTotalSpecProp** . This parameter is optional. The default value is _false_ . Not applicable to list objects. |
| `qFrequency` | `string` | Frequency of the value. This parameter is optional. |
| `qHighlightRanges` | [NxHighlightRanges](#nxhighlightranges) | |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
| `qIsNull` | `boolean` | Is set to _true_ if the value is Null. |
| `qMiniChart` | [NxMiniChartData](#nxminichartdata) | |
| `qInExtRow` | `boolean` | |
Properties of `qState`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
Properties of `qHighlightRanges`
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qMiniChart`
_Properties truncated due to depth limit._
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDataPage` | [NxDataPage](#nxdatapage) | |
Properties of `NxDataPage`
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxCellRows](#nxcellrows) | Array of data. |
| `qTails` | `array` of [NxGroupTail](#nxgrouptail) | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty _[ ]_ . |
| `qArea` | [Rect](#rect) | |
| `qIsReduced` | `boolean` | Is set to true, if the data have been reduced. The default value is false. |
Properties of `qMatrix`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTails`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
Properties of `qPivotDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPivotPage` | [NxPivotPage](#nxpivotpage) | |
Properties of `NxPivotPage`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about the left dimension values of a pivot table. |
| `qTop` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given. |
| `qData` | `array` of [ArrayOfNxValuePoint](#arrayofnxvaluepoint) | Array of data. |
| `qArea` | [Rect](#rect) | |
Properties of `qLeft`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTop`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qData`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
Properties of `qStackedDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxStackPage` | [NxStackPage](#nxstackpage) | |
Properties of `NxStackPage`
| Name | Type | Description |
| --- | --- | --- |
| `qData` | `array` of [NxStackedPivotCell](#nxstackedpivotcell) | Array of data. |
| `qArea` | [Rect](#rect) | |
Properties of `qData`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
Properties of `qMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | DATA_MODE_STRAIGHT |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | DATA_MODE_PIVOT |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `K` | `object` | DATA_MODE_PIVOT_STACK |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | DATA_MODE_TREE |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATA_MODE_DYNAMIC |
Properties of `qLastExpandedPos`
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | Position of the cell on the x-axis. |
| `qy` | `integer` | Position of the cell on the y-axis. |
Properties of `qTreeNodesOnDim`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qColumnOrder`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### HyperCubeDef
Defines the properties of a hypercube.
For more information about the definition of a hypercube, see _Generic object_.
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
| `qDimensions` | `array` of [NxDimension](#nxdimension) | Array of dimensions. |
| `qMeasures` | `array` of [NxMeasure](#nxmeasure) | Array of measures. |
| `qInterColumnSortOrder` | `array of integer` | Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure. |
| `qSuppressZero` | `boolean` | Removes zero values. |
| `qSuppressMissing` | `boolean` | Removes missing values. |
| `qInitialDataFetch` | `array` of [NxPage](#nxpage) | Initial data set. |
| `qReductionMode` | oneOf(N \| D1 \| S \| C \| ST) | |
| `qMode` | oneOf(S \| P \| K \| T \| D) | |
| `qPseudoDimPos` | `integer` | |
| `qNoOfLeftDims` | `integer` | Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with: * Four dimensions in the following order: Country, City, Product and Category. * One pseudo dimension in position 1 (the position is defined in _qInterColumnSortOrder_ ) _qInterColumnSortOrder_ is (0,-1,1,2,3). * Three left dimensions ( _qNoOfLeftDims_ is set to 3). implies that: * The index 0 corresponds to the left dimension Country. * The index 1 corresponds to the pseudo dimension. * The index 2 corresponds to the left dimension City. * Product and Category are top dimensions. Another example: * Four dimensions in the following order: Country, City, Product and Category. * Three left dimensions ( _qNoOfLeftDims_ is set to 3). * One pseudo dimension. * The property _qInterColumnSortOrder_ is left empty. Implies that: * The index 0 corresponds to the left dimension Country. * The index 1 corresponds to the left dimension City. * The index 2 corresponds to the left dimension Product. * Category is a top dimension. * The pseudo dimension is a top dimension. |
| `qAlwaysFullyExpanded` | `boolean` | If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false. |
| `qMaxStackedCells` | `integer` | Maximum number of cells for an initial data fetch (set in _qInitialDataFetch_ ) when in stacked mode ( _qMode_ is K). The default value is 5000. |
| `qPopulateMissing` | `boolean` | If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false. |
| `qShowTotalsAbove` | `boolean` | If set to true, the total (if any) is shown on the first row. The default value is false. |
| `qIndentMode` | `boolean` | This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false. |
| `qCalcCond` | [ValueExpr](#valueexpr) | |
| `qSortbyYValue` | `integer` | To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table. |
| `qTitle` | [StringExpr](#stringexpr) | |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
| `qColumnOrder` | `array of integer` | The order of the columns. |
| `qExpansionState` | `array` of [ExpansionData](#expansiondata) | Expansion state per dimension for pivot mode ( _qMode_ is P). |
| `qDynamicScript` | `array of string` | Hypercube Modifier Dynamic script string |
| `qContextSetExpression` | `string` | Set Expression valid for the whole cube. Used to limit computations to the set specified. |
| `qSuppressMeasureTotals` | `boolean` | If set to true, suppress any measure grand totals, ignoring any AggrFunc. |
Properties of `qDimensions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDimension` | [NxDimension](#nxdimension) | The fields or expressions in the dimension are either defined in **qDef** or in the master dimension referred to by **qLibraryId**. If **qLibraryId** is set then the qFieldDefs, qFieldLabels, qGrouping, qLabelExpression and qAlias of the master dimension will be used.
If the dimension is set in the hypercube and not in the library, this dimension cannot be shared with other objects.
A dimension that is set in the library can be used by many objects.
|
Properties of `NxDimension`
| Name | Type | Description |
| --- | --- | --- |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qDef` | [NxInlineDimensionDef](#nxinlinedimensiondef) | |
| `qNullSuppression` | `boolean` | If set to true, no null values are returned. |
| `qIncludeElemValue` | `boolean` | |
| `qOtherTotalSpec` | [OtherTotalSpecProp](#othertotalspecprop) | |
| `qShowTotal` | `boolean` | |
| `qShowAll` | `boolean` | If set to true, all dimension values are shown. |
| `qOtherLabel` | [StringExpr](#stringexpr) | |
| `qTotalLabel` | [StringExpr](#stringexpr) | |
| `qCalcCond` | [ValueExpr](#valueexpr) | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qAttributeDimensions` | `array` of [NxAttrDimDef](#nxattrdimdef) | List of attribute dimensions. |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
Properties of `qDef`
_Properties truncated due to depth limit._
Properties of `qOtherTotalSpec`
_Properties truncated due to depth limit._
Properties of `qOtherLabel`
_Properties truncated due to depth limit._
Properties of `qTotalLabel`
_Properties truncated due to depth limit._
Properties of `qCalcCond`
_Properties truncated due to depth limit._
Properties of `qAttributeExpressions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttributeDimensions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCalcCondition`
_Properties truncated due to depth limit._
Properties of `qMeasures`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMeasure` | [NxMeasure](#nxmeasure) | Either **qDef** or **qLibraryId** must be set, but not both. If both are set, the library measure's qDef and qLabel will be used.
If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.
A measure that is set in the library can be used by many objects.
expressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure. Attribute expressions do not affect the layout of an object. The sorting order is unchanged.
|
Properties of `NxMeasure`
| Name | Type | Description |
| --- | --- | --- |
| `qLibraryId` | `string` | Refers to a measure stored in the library. |
| `qDef` | [NxInlineMeasureDef](#nxinlinemeasuredef) | |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qAttributeDimensions` | `array` of [NxAttrDimDef](#nxattrdimdef) | List of attribute dimensions. |
| `qCalcCond` | [ValueExpr](#valueexpr) | |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
| `qTrendLines` | `array` of [NxTrendlineDef](#nxtrendlinedef) | Specifies trendlines for this measure. |
| `qMiniChartDef` | [NxMiniChartDef](#nxminichartdef) | |
Properties of `qDef`
_Properties truncated due to depth limit._
Properties of `qSortBy`
_Properties truncated due to depth limit._
Properties of `qAttributeExpressions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttributeDimensions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCalcCond`
_Properties truncated due to depth limit._
Properties of `qCalcCondition`
_Properties truncated due to depth limit._
Properties of `qTrendLines`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMiniChartDef`
_Properties truncated due to depth limit._
Properties of `qInterColumnSortOrder`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qInitialDataFetch`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPage` | [NxPage](#nxpage) | |
Properties of `NxPage`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
Properties of `qReductionMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | DATA_REDUCTION_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `D1` | `object` | DATA_REDUCTION_ONEDIM |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | DATA_REDUCTION_SCATTERED |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | DATA_REDUCTION_CLUSTERED |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `ST` | `object` | DATA_REDUCTION_STACKED |
Properties of `qMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | DATA_MODE_STRAIGHT |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | DATA_MODE_PIVOT |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `K` | `object` | DATA_MODE_PIVOT_STACK |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | DATA_MODE_TREE |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATA_MODE_DYNAMIC |
Properties of `qCalcCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qTitle`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qCalcCondition`
| Name | Type | Description |
| --- | --- | --- |
| `qCond` | [ValueExpr](#valueexpr) | |
| `qMsg` | [StringExpr](#stringexpr) | |
Properties of `qCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qMsg`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qColumnOrder`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qExpansionState`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ExpansionData` | [ExpansionData](#expansiondata) | |
Properties of `ExpansionData`
| Name | Type | Description |
| --- | --- | --- |
| `qExcludeList` | `boolean` | |
| `qPos` | [PositionMark](#positionmark) | |
Properties of `qPos`
_Properties truncated due to depth limit._
Properties of `qDynamicScript`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### InputFieldItem
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | |
| `qValues` | `array` of [FieldValue](#fieldvalue) | |
| `qPackedHashKeys` | `array of integer` | |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldValue` | [FieldValue](#fieldvalue) | |
Properties of `FieldValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
Properties of `qPackedHashKeys`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### InterFieldSortData
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | |
| `qReversed` | `boolean` | |
---
### InteractDef
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(IT_MSGBOX \| IT_SCRIPTLINE \| IT_BREAK \| IT_INPUT \| IT_END \| IT_PASSWD \| IT_USERNAME) | |
| `qTitle` | `string` | Title used in the message box dialog. This property is relevant if _qType_ is *IT_MSGBOX*. |
| `qMsg` | `string` | Message used in the message box dialog. This property is relevant if _qType_ is *IT_MSGBOX*. |
| `qButtons` | `integer` | Buttons displayed in the message box dialog. This property is relevant if _qType_ is *IT_MSGBOX*. One of: * 0 means that the _qButtons_ property is not relevant. * 17 means that the message box contains the **OK** and **Cancel** buttons or the **stop** -sign icon. |
| `qLine` | `string` | Next script statement to be executed. This property is used if the type of interaction is *IT_SCRIPTLINE*. |
| `qOldLineNr` | `integer` | First line number of the previously executed statement. This property is used if the type of interaction is *IT_SCRIPTLINE*. |
| `qNewLineNr` | `integer` | First line number of the next statement to be executed. This property is used if the type of interaction is *IT_SCRIPTLINE*. |
| `qPath` | `string` | Path specified by the **Include** script variable. This property is used if the type of interaction is *IT_SCRIPTLINE*. Example of an **Include** variable: _$(Include=lib:\\\MyDataFiles\abc.txt);_ |
| `qHidden` | `boolean` | This property is set to true if the returned statement is an hidden script statement. |
| `qResult` | `integer` | Not relevant for describing the requested user interaction. |
| `qInput` | `string` | Is not used in Qlik Sense. |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_MSGBOX` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_SCRIPTLINE` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_BREAK` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_INPUT` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_END` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_PASSWD` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_USERNAME` | `object` | |
---
### InteractType
| Name | Type | Description |
| --- | --- | --- |
| `InteractType` | oneOf(IT_MSGBOX \| IT_SCRIPTLINE \| IT_BREAK \| IT_INPUT \| IT_END \| IT_PASSWD \| IT_USERNAME) | |
Properties of `InteractType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_MSGBOX` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_SCRIPTLINE` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_BREAK` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_INPUT` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_END` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_PASSWD` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `IT_USERNAME` | `object` | |
---
### JsonObject
Contains dynamic JSON data specified by the client.
---
### KeyType
| Name | Type | Description |
| --- | --- | --- |
| `KeyType` | oneOf(NOT_KEY \| ANY_KEY \| PRIMARY_KEY \| PERFECT_KEY) | |
Properties of `KeyType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT_KEY` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `ANY_KEY` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `PRIMARY_KEY` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `PERFECT_KEY` | `object` | |
---
### LayoutBookmarkData
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | |
| `qActive` | `boolean` | |
| `qShowMode` | `integer` | |
| `qScrollPos` | [ScrollPosition](#scrollposition) | |
Properties of `qScrollPos`
| Name | Type | Description |
| --- | --- | --- |
| `qUsePosition` | `boolean` | |
| `qPos` | [Point](#point) | |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | x-coordinate in pixels. The origin is the top left of the screen. |
| `qy` | `integer` | y-coordinate in pixels. The origin is the top left of the screen. |
---
### LayoutExclude
Contains JSON to be excluded from validation.
---
### LayoutFieldInfo
Meta data about the selection in a field.
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | The name of the field. |
| `qValuesCount` | `integer` | Number of selected values in the field. |
| `qExcludedValuesCount` | `integer` | Number of excluded values in the field. |
---
### LineageInfo
| Name | Type | Description |
| --- | --- | --- |
| `qDiscriminator` | `string` | A string indicating the origin of the data: * [filename]: the data comes from a local file. * INLINE: the data is entered inline in the load script. * RESIDENT: the data comes from a resident table. The table name is listed. * AUTOGENERATE: the data is generated from the load script (no external table of data source). * Provider: the data comes from a data connection. The connector source name is listed. * [webfile]: the data comes from a web-based file. * STORE: path to QVD or TXT file where data is stored. * EXTENSION: the data comes from a Server Side Extension (SSE). |
| `qStatement` | `string` | The LOAD and SELECT script statements from the data load script. |
---
### ListObject
Renders the properties of a list object. Is the layout for _ListObjectDef_.
For more information about the definition of a list object, see _Generic object_.
ListObject is used by the _GetLayout Method_ to display the properties of a list object.
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
| `qSize` | [Size](#size) | |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qDimensionInfo` | [NxDimensionInfo](#nxdimensioninfo) | |
| `qExpressions` | `array` of [NxListObjectExpression](#nxlistobjectexpression) | Lists the expressions in the list object. |
| `qDataPages` | `array` of [NxDataPage](#nxdatapage) | Set of data. Is empty if nothing has been defined in **qInitialDataFetch** in _ListObjectDef_. |
Properties of `qSize`
| Name | Type | Description |
| --- | --- | --- |
| `qcx` | `integer` | Number of pixels on the _x_ axis. |
| `qcy` | `integer` | Number of pixels on the _y_ axis. |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
Properties of `qDimensionInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qLocked` | `boolean` | Is set to true if the field is locked. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qGroupFallbackTitles` | `array of string` | Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group). |
| `qGroupPos` | `integer` | Index of the dimension that is currently in use. _qGroupPos_ is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups. |
| `qStateCounts` | [NxStateCounts](#nxstatecounts) | |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qDimensionType` | oneOf(D \| N \| T) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's definition. |
| `qGroupFieldDefs` | `array of string` | Array of field names. |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qContinuousAxes` | `boolean` | Is continuous axis used. |
| `qIsCyclic` | `boolean` | Is a cyclic dimension used. |
| `qDerivedField` | `boolean` | Is derived field is used as a dimension. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | Array of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | Array of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
| `qIsOneAndOnlyOne` | `boolean` | If set to true, it means that the field always has one and only one selected value. |
| `qCardinalities` | [NxCardinalities](#nxcardinalities) | |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qEffectiveDimensionName` | `string` | The expanded and stripped dimension name used internally in engine. |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_SORT_INDICATE_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_SORT_INDICATE_ASC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_SORT_INDICATE_DESC |
Properties of `qGroupFallbackTitles`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qStateCounts`
| Name | Type | Description |
| --- | --- | --- |
| `qLocked` | `integer` | Number of values in locked state. |
| `qSelected` | `integer` | Number of values in selected state. |
| `qOption` | `integer` | Number of values in optional state. |
| `qDeselected` | `integer` | Number of values in deselected state. |
| `qAlternative` | `integer` | Number of values in alternative state. |
| `qExcluded` | `integer` | Number of values in excluded state. |
| `qSelectedExcluded` | `integer` | Number of values in selected excluded state. |
| `qLockedExcluded` | `integer` | Number of values in locked excluded state. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
Properties of `qDimensionType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_DIMENSION_TYPE_DISCRETE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIMENSION_TYPE_NUMERIC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIMENSION_TYPE_TIME |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qGroupFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qAttrExprInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprInfo` | [NxAttrExprInfo](#nxattrexprinfo) | Layout for _NxAttrExprDef_. |
Properties of `NxAttrExprInfo`
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrDimInfo` | [NxAttrDimInfo](#nxattrdiminfo) | Layout for _NxAttrDimDef_. |
Properties of `NxAttrDimInfo`
_Properties truncated due to depth limit._
Properties of `qCardinalities`
| Name | Type | Description |
| --- | --- | --- |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qHypercubeCardinal` | `integer` | Number of distinct hypercube values. |
| `qAllValuesCardinal` | `integer` | Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure. |
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxListObjectExpression` | [NxListObjectExpression](#nxlistobjectexpression) | |
Properties of `NxListObjectExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qExpr` | `string` | Value of the expression. |
| `qError` | [NxLayoutErrors](#nxlayouterrors) | |
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDataPage` | [NxDataPage](#nxdatapage) | |
Properties of `NxDataPage`
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxCellRows](#nxcellrows) | Array of data. |
| `qTails` | `array` of [NxGroupTail](#nxgrouptail) | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty _[ ]_ . |
| `qArea` | [Rect](#rect) | |
| `qIsReduced` | `boolean` | Is set to true, if the data have been reduced. The default value is false. |
Properties of `qMatrix`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTails`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qArea`
_Properties truncated due to depth limit._
---
### ListObjectDef
Defines the properties of a list object.
For more information about the definition of a list object, see _Generic object_.
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qDef` | [NxInlineDimensionDef](#nxinlinedimensiondef) | |
| `qAutoSortByState` | [NxAutoSortByStateDef](#nxautosortbystatedef) | |
| `qFrequencyMode` | oneOf(N \| V \| P \| R) | |
| `qShowAlternatives` | `boolean` | If set to true, alternative values are allowed in _qData_ . If set to false, no alternative values are displayed in _qData_ . Values are excluded instead. The default value is false. Note that on the contrary, the _qStateCounts_ parameter counts the excluded values as alternative values. This parameter is optional. |
| `qInitialDataFetch` | `array` of [NxPage](#nxpage) | Fetches an initial data set. |
| `qExpressions` | `array` of [NxListObjectExpressionDef](#nxlistobjectexpressiondef) | Lists the expressions in the list object. This parameter is optional. |
| `qDirectQuerySimplifiedView` | `boolean` | If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false. |
Properties of `qDef`
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional. |
| `qFieldLabels` | `array of string` | Array of field labels. This parameter is optional. |
| `qSortCriterias` | `array` of [SortCriteria](#sortcriteria) | Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional. |
| `qNumberPresentations` | `array` of [FieldAttributes](#fieldattributes) | Defines the format of the value. This parameter is optional. |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qActiveField` | `integer` | Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( _qGrouping_ is C). |
| `qLabelExpression` | `string` | Label expression. This parameter is optional. |
| `qAlias` | `string` | Alias of the dimension. |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSortCriterias`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SortCriteria` | [SortCriteria](#sortcriteria) | |
Properties of `SortCriteria`
_Properties truncated due to depth limit._
Properties of `qNumberPresentations`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldAttributes` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
Properties of `FieldAttributes`
_Properties truncated due to depth limit._
Properties of `qAutoSortByState`
| Name | Type | Description |
| --- | --- | --- |
| `qDisplayNumberOfRows` | `integer` | 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. |
Properties of `qFrequencyMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_FREQUENCY_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | NX_FREQUENCY_VALUE |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | NX_FREQUENCY_PERCENT |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | NX_FREQUENCY_RELATIVE |
Properties of `qInitialDataFetch`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPage` | [NxPage](#nxpage) | |
Properties of `NxPage`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxListObjectExpressionDef` | [NxListObjectExpressionDef](#nxlistobjectexpressiondef) | |
Properties of `NxListObjectExpressionDef`
| Name | Type | Description |
| --- | --- | --- |
| `qExpr` | `string` | Value of the expression. |
| `qLibraryId` | `string` | Refers to an expression stored in the library. |
---
### LocaleInfo
| Name | Type | Description |
| --- | --- | --- |
| `qDecimalSep` | `string` | Decimal separator. |
| `qThousandSep` | `string` | Thousand separator. |
| `qListSep` | `string` | List separator. |
| `qMoneyDecimalSep` | `string` | Money decimal separator. |
| `qMoneyThousandSep` | `string` | Money thousand separator. |
| `qCurrentYear` | `integer` | Current year. |
| `qMoneyFmt` | `string` | Money format. Example: _#.##0,00 kr;-#.##0,00 kr_ |
| `qTimeFmt` | `string` | Time format. Example: _hh:mm:ss_ |
| `qDateFmt` | `string` | Date format. Example: _YYYY-MM-DD_ |
| `qTimestampFmt` | `string` | Time stamp format. Example: _YYYY-MM-DD hh:mm:ss[.fff]_ |
| `qCalendarStrings` | [CalendarStrings](#calendarstrings) | |
| `qFirstWeekDay` | `integer` | First day of the week, starting from 0. According to ISO 8601, _Monday_ is the first day of the week. * 0 = Monday * 1 = Tuesday * ... * 6 = Sunday If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qBrokenWeeks` | `boolean` | Is set to true if broken weeks are allowed in a year. According to ISO 8601, no broken weeks should be allowed. This property is not shown if set to false. If _qBrokenWeeks_ is set to true, _qReferenceDay_ is irrelevant. If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qReferenceDay` | `integer` | Day in the year that is always in week 1. According to ISO 8601, January 4th should always be part of the first week of the year ( _qReferenceDay_ =4). Recommended values are in the range 1 and 7. If this property has not been set in a script, the returned value comes from the Windows operating system. This property is not relevant if there are broken weeks in the year. |
| `qFirstMonthOfYear` | `integer` | First month of the year, starting from 1. According to ISO 8601, _January_ is the first month of the year. * 1 = January * 2 = February * 12 = January If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qCollation` | `string` | Locale name (following language tagging convention RFC 4646): _< language>-<REGION>_ Where: * _language_ is a lowercase ISO 639 language code * _REGION_ specifies an uppercase ISO 3166 country code. If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qNumericalAbbreviation` | `string` | Number format. Example: 3:k;6:M;9:G;12:T;15:P;18:E;21:Z;24:Y;-3:m;-6:μ;-9:n;-12:p;-15:f;-18:a;-21:z;-24:y |
Properties of `qCalendarStrings`
| Name | Type | Description |
| --- | --- | --- |
| `qDayNames` | `array of string` | List of short day names. |
| `qMonthNames` | `array of string` | List of short month names. |
| `qLongDayNames` | `array of string` | List of long day names. |
| `qLongMonthNames` | `array of string` | List of long month names. |
Properties of `qDayNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qMonthNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qLongDayNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qLongMonthNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### LogOnType
| Name | Type | Description |
| --- | --- | --- |
| `LogOnType` | oneOf(LOG_ON_SERVICE_USER \| LOG_ON_CURRENT_USER) | |
Properties of `LogOnType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG_ON_SERVICE_USER` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG_ON_CURRENT_USER` | `object` | |
---
### MeasureList
Lists the measures. Is the layout for _MeasureListDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxContainerEntry](#nxcontainerentry) | Information about the list of measures. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxContainerEntry` | [NxContainerEntry](#nxcontainerentry) | |
Properties of `NxContainerEntry`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qMeta`
_Properties truncated due to depth limit._
---
### MeasureListDef
Defines the list of measures.
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | Type of the list. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
---
### MediaList
Lists the media files. Is the layout for _MediaListDef_.
This struct is deprecated.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [MediaListItem](#medialistitem) | Information about the list of media files. In Qlik Sense Desktop, the media files are retrieved from: _%userprofile%\Documents\Qlik\Sense\Content\Default_ In Qlik Sense Enterprise, the media files are retrieved from: <installation_directory>\Qlik\Sense\Repository\Content\Default The default installation directory is _ProgramData_ . |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `MediaListItem` | [MediaListItem](#medialistitem) | In addition, this structure can return dynamic properties.
|
Properties of `MediaListItem`
| Name | Type | Description |
| --- | --- | --- |
| `qUrlDef` | `string` | Relative path to the media file. The URL is static. Media files located: * in the _/content/default/_ folder are outside the qvf file. * in the _/media/ folder_ are embedded in the qvf file. |
| `qUrl` | `string` | Relative path to the media file. Media files located: * in the _/content/default/_ folder are outside the qvf file. * in the _/media/ folder_ are embedded in the qvf file. |
---
### MediaListDef
Defines the list of media files.
This struct is deprecated.
**Properties**
"qMediaListDef": {}
_qMediaListDef_ has an empty structure. No properties need to be set.
---
### MediaListItem
In addition, this structure can return dynamic properties.
| Name | Type | Description |
| --- | --- | --- |
| `qUrlDef` | `string` | Relative path to the media file. The URL is static. Media files located: * in the _/content/default/_ folder are outside the qvf file. * in the _/media/ folder_ are embedded in the qvf file. |
| `qUrl` | `string` | Relative path to the media file. Media files located: * in the _/content/default/_ folder are outside the qvf file. * in the _/media/ folder_ are embedded in the qvf file. |
---
### MetaData
| Name | Type | Description |
| --- | --- | --- |
| `qShared` | `boolean` | |
| `qUtcModifyTime` | `number` | |
| `qSheetId` | `string` | |
| `qTemporary` | `boolean` | |
| `qRestrictedAccess` | `boolean` | |
| `qAccessList` | `array of string` | |
| `qPersonalEditionHash_OBSOLETE` | `string` | |
| `qHidden` | `boolean` | |
| `qLinkedTo` | `array of string` | |
Properties of `qAccessList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qLinkedTo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxAppLayout
**Qlik Sense Desktop**
In Qlik Sense Desktop, this structure can contain dynamic properties.
**Qlik Sense Enterprise**
In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.
The persisted dynamic properties are the following:
* modifiedDate
* published
* publishTime
* privileges
* description
* dynamicColor
| Name | Type | Description |
| --- | --- | --- |
| `qTitle` | `string` | Title of the app. |
| `qFileName` | `string` | In Qlik Sense Enterprise, this property corresponds to the app identifier (GUID). In Qlik Sense Desktop, this property corresponds to the full path of the app. |
| `qLastReloadTime` | `string` | Date and time of the last reload of the app in ISO format. |
| `qModified` | `boolean` | Is set to true if the app has been updated since the last save. |
| `qHasScript` | `boolean` | Is set to true if a script is defined in the app. |
| `qStateNames` | `array of string` | Array of alternate states. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qLocaleInfo` | [LocaleInfo](#localeinfo) | |
| `qHasData` | `boolean` | Is set to true if the app contains data following a script reload. |
| `qReadOnly` | `boolean` | If set to true, it means that the app is read-only. |
| `qIsOpenedWithoutData` | `boolean` | If set to true, it means that the app was opened without loading its data. |
| `qIsSessionApp` | `boolean` | If set to true, the app is a Session App, i.e. not persistent. |
| `qProhibitBinaryLoad` | `boolean` | If set to true, the persisted app cannot be used in a Binary load statement in Qlik load script. |
| `qThumbnail` | [StaticContentUrl](#staticcontenturl) | In addition, this structure can return dynamic properties.
|
| `qIsBDILiveMode` | `boolean` | If set to true, the app is in BDI Direct Query Mode. |
| `qIsDirectQueryMode` | `boolean` | If set to true, the app is in Direct Query Mode. |
| `qUnsupportedFeatures` | `array` of [NxFeature](#nxfeature) | Array of features not supported by the app. |
| `qUsage` | oneOf(ANALYTICS \| DATA_PREPARATION \| DATAFLOW_PREP \| SINGLE_TABLE_PREP \| DIRECT_QUERY_MODE) | |
Properties of `qStateNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qLocaleInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qDecimalSep` | `string` | Decimal separator. |
| `qThousandSep` | `string` | Thousand separator. |
| `qListSep` | `string` | List separator. |
| `qMoneyDecimalSep` | `string` | Money decimal separator. |
| `qMoneyThousandSep` | `string` | Money thousand separator. |
| `qCurrentYear` | `integer` | Current year. |
| `qMoneyFmt` | `string` | Money format. Example: _#.##0,00 kr;-#.##0,00 kr_ |
| `qTimeFmt` | `string` | Time format. Example: _hh:mm:ss_ |
| `qDateFmt` | `string` | Date format. Example: _YYYY-MM-DD_ |
| `qTimestampFmt` | `string` | Time stamp format. Example: _YYYY-MM-DD hh:mm:ss[.fff]_ |
| `qCalendarStrings` | [CalendarStrings](#calendarstrings) | |
| `qFirstWeekDay` | `integer` | First day of the week, starting from 0. According to ISO 8601, _Monday_ is the first day of the week. * 0 = Monday * 1 = Tuesday * ... * 6 = Sunday If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qBrokenWeeks` | `boolean` | Is set to true if broken weeks are allowed in a year. According to ISO 8601, no broken weeks should be allowed. This property is not shown if set to false. If _qBrokenWeeks_ is set to true, _qReferenceDay_ is irrelevant. If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qReferenceDay` | `integer` | Day in the year that is always in week 1. According to ISO 8601, January 4th should always be part of the first week of the year ( _qReferenceDay_ =4). Recommended values are in the range 1 and 7. If this property has not been set in a script, the returned value comes from the Windows operating system. This property is not relevant if there are broken weeks in the year. |
| `qFirstMonthOfYear` | `integer` | First month of the year, starting from 1. According to ISO 8601, _January_ is the first month of the year. * 1 = January * 2 = February * 12 = January If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qCollation` | `string` | Locale name (following language tagging convention RFC 4646): _< language>-<REGION>_ Where: * _language_ is a lowercase ISO 639 language code * _REGION_ specifies an uppercase ISO 3166 country code. If this property has not been set in a script, the returned value comes from the Windows operating system. |
| `qNumericalAbbreviation` | `string` | Number format. Example: 3:k;6:M;9:G;12:T;15:P;18:E;21:Z;24:Y;-3:m;-6:μ;-9:n;-12:p;-15:f;-18:a;-21:z;-24:y |
Properties of `qCalendarStrings`
| Name | Type | Description |
| --- | --- | --- |
| `qDayNames` | `array of string` | List of short day names. |
| `qMonthNames` | `array of string` | List of short month names. |
| `qLongDayNames` | `array of string` | List of long day names. |
| `qLongMonthNames` | `array of string` | List of long month names. |
Properties of `qDayNames`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMonthNames`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qLongDayNames`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qLongMonthNames`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qThumbnail`
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
Properties of `qUnsupportedFeatures`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxFeature` | oneOf(binningData \| bookmarks \| calculatedFields \| continuousData \| invertedSelections \| rangeSelections \| reducingData \| search \| selectionCount \| selectionInsights \| tableMiniChart \| trendlines \| calculatedDimensions \| includeZeroValues \| includeNullValues \| filterPanePaging \| filterPaneCustomSorting \| showFrequency \| limitation \| totals) | |
Properties of `NxFeature`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `binningData` | `object` | FEATURE_BINNING_DATA |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `bookmarks` | `object` | FEATURE_BOOKMARKS |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `calculatedFields` | `object` | FEATURE_CALCULATED_FIELDS |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `continuousData` | `object` | FEATURE_CONTINUOUS_DATA |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `invertedSelections` | `object` | FEATURE_INVERTED_SELECTIONS |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `rangeSelections` | `object` | FEATURE_RANGE_SELECTIONS |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `reducingData` | `object` | FEATURE_REDUCING_DATA |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `search` | `object` | FEATURE_SEARCH |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `selectionCount` | `object` | FEATURE_SELECTION_COUNT |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `selectionInsights` | `object` | FEATURE_SELECTION_INSIGHTS |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `tableMiniChart` | `object` | FEATURE_TABLE_MINI_CHART |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `trendlines` | `object` | FEATURE_TRENDLINES |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `calculatedDimensions` | `object` | FEATURE_CALCULATED_DIMENSIONS |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `includeZeroValues` | `object` | FEATURE_INCLUDE_ZERO_VALUES |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `includeNullValues` | `object` | FEATURE_INCLUDE_NULL_VALUES |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `filterPanePaging` | `object` | FEATURE_FILTER_PANE_PAGING |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `filterPaneCustomSorting` | `object` | FEATURE_FILTER_PANE_CUSTOM_SORTING |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `showFrequency` | `object` | FEATURE_SHOW_FREQUENCY |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `limitation` | `object` | FEATURE_LIMITATION |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `totals` | `object` | FEATURE_TOTALS |
Properties of `qUsage`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ANALYTICS` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `DATA_PREPARATION` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DATAFLOW_PREP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `SINGLE_TABLE_PREP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `DIRECT_QUERY_MODE` | `object` | |
---
### NxAppProperties
**Qlik Sense Desktop**
In Qlik Sense Desktop, this structure can contain dynamic properties.
**Qlik Sense Enterprise**
In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.
The persisted dynamic properties are the following:
* modifiedDate
* published
* publishTime
* privileges
* description
* dynamicColor
| Name | Type | Description |
| --- | --- | --- |
| `qTitle` | `string` | App title. |
| `qLastReloadTime` | `string` | Last reload time of the app. |
| `qMigrationHash` | `string` | Internal property reserved for app migration. Patch version of the app. Do not update. |
| `qSavedInProductVersion` | `string` | Internal property reserved for app migration. The app is saved in this version of the product. Do not update. |
| `qThumbnail` | [StaticContentUrlDef](#staticcontenturldef) | In addition, this structure can contain dynamic properties.
|
| `qHasSectionAccess` | `boolean` | If true the app has section access configured. |
| `qUsage` | oneOf(ANALYTICS \| DATA_PREPARATION \| DATAFLOW_PREP \| SINGLE_TABLE_PREP \| DIRECT_QUERY_MODE) | |
Properties of `qThumbnail`
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
Properties of `qUsage`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ANALYTICS` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `DATA_PREPARATION` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DATAFLOW_PREP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `SINGLE_TABLE_PREP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `DIRECT_QUERY_MODE` | `object` | |
---
### NxAttrDimDef
Layout for _NxAttrDimDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | `string` | Expression or field name. |
| `qLibraryId` | `string` | LibraryId for dimension. |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qAttribute` | `boolean` | If set to true, this attribute will not affect the number of rows in the cube. |
Properties of `qSortBy`
| Name | Type | Description |
| --- | --- | --- |
| `qSortByState` | `integer` | Sorts the field values according to their logical state (selected, optional, alternative or excluded). |
| `qSortByFrequency` | `integer` | Sorts the field values by frequency (number of occurrences in the field). |
| `qSortByNumeric` | `integer` | Sorts the field values by numeric value. |
| `qSortByAscii` | `integer` | Sorts the field by alphabetical order. |
| `qSortByLoadOrder` | `integer` | Sorts the field values by the initial load order. |
| `qSortByExpression` | `integer` | Sorts the field by expression. |
| `qExpression` | [ValueExpr](#valueexpr) | |
| `qSortByGreyness` | `integer` | |
Properties of `qExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
---
### NxAttrDimInfo
Layout for _NxAttrDimDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qCardinal` | `integer` | Cardinality of the attribute expression. |
| `qSize` | [Size](#size) | |
| `qFallbackTitle` | `string` | The title for the attribute dimension. |
| `qLocked` | `boolean` | The Locked value of the dimension. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
Properties of `qSize`
| Name | Type | Description |
| --- | --- | --- |
| `qcx` | `integer` | Number of pixels on the _x_ axis. |
| `qcy` | `integer` | Number of pixels on the _y_ axis. |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
---
### NxAttrExprDef
| Name | Type | Description |
| --- | --- | --- |
| `qExpression` | `string` | Definition of the attribute expression. Example: _"Max(OrderID)"_ |
| `qLibraryId` | `string` | Definition of the attribute expression stored in the library. Example: _"MyGenericMeasure"_ |
| `qAttribute` | `boolean` | If set to true, this measure will not affect the number of rows in the cube. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qLabel` | `string` | Label of the attribute expression. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
---
### NxAttrExprInfo
Layout for _NxAttrExprDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qFallbackTitle` | `string` | |
| `qMinText` | `string` | String version of the minimum Value. |
| `qMaxText` | `string` | String version of the maximum Value. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
---
### NxAttributeDimValues
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleDimValue](#nxsimpledimvalue) | List of values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleDimValue` | [NxSimpleDimValue](#nxsimpledimvalue) | |
Properties of `NxSimpleDimValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric. |
| `qElemNo` | `integer` | Element number. |
---
### NxAttributeExpressionValues
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleValue](#nxsimplevalue) | List of attribute expressions values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleValue` | [NxSimpleValue](#nxsimplevalue) | |
Properties of `NxSimpleValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the attribute expression value. |
| `qNum` | `number` | Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric. |
---
### NxAutoSortByStateDef
| Name | Type | Description |
| --- | --- | --- |
| `qDisplayNumberOfRows` | `integer` | 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. |
---
### NxAxisData
| Name | Type | Description |
| --- | --- | --- |
| `qAxis` | `array` of [NxAxisTicks](#nxaxisticks) | List of axis data. |
Properties of `qAxis`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAxisTicks` | [NxAxisTicks](#nxaxisticks) | |
Properties of `NxAxisTicks`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the derived definition. |
| `qTags` | `array of string` | List of tags. |
| `qTicks` | `array` of [NxTickCell](#nxtickcell) | List of ticks. |
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTicks`
**Array items:**
_Properties truncated due to depth limit._
---
### NxAxisTicks
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the derived definition. |
| `qTags` | `array of string` | List of tags. |
| `qTicks` | `array` of [NxTickCell](#nxtickcell) | List of ticks. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qTicks`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTickCell` | [NxTickCell](#nxtickcell) | |
Properties of `NxTickCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Tick's label. |
| `qStart` | `number` | Start value. |
| `qEnd` | `number` | End value. |
---
### NxBookmark
| Name | Type | Description |
| --- | --- | --- |
| `qStateData` | `array` of [AlternateStateData](#alternatestatedata) | List of selections for each state. |
| `qUtcModifyTime` | `number` | Time when the bookmark was created. |
| `qVariableItems` | `array` of [BookmarkVariableItem](#bookmarkvariableitem) | List of the variables in the app at the time the bookmark was created. |
| `qPatches` | `array` of [NxPatches](#nxpatches) | Softpatches to be applied with this bookmark. |
| `qCyclicGroupStates` | `array` of [CyclicGroupPosition](#cyclicgroupposition) | Information about cyclic groups by zero-based index. This field is unused. |
| `qGroupStates` | `array` of [GroupState](#groupstate) | Information about cyclic groups indexed by field definition. |
Properties of `qStateData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `AlternateStateData` | [AlternateStateData](#alternatestatedata) | |
Properties of `AlternateStateData`
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections: $ |
| `qFieldItems` | `array` of [BookmarkFieldItem](#bookmarkfielditem) | List of the selections. |
Properties of `qFieldItems`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qVariableItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `BookmarkVariableItem` | [BookmarkVariableItem](#bookmarkvariableitem) | |
Properties of `BookmarkVariableItem`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the variable. |
| `qValue` | [FieldValue](#fieldvalue) | |
| `qDefinition` | `string` | The Reporting mode definition of the variable. |
Properties of `qValue`
_Properties truncated due to depth limit._
Properties of `qPatches`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPatches` | [NxPatches](#nxpatches) | |
Properties of `NxPatches`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qPatches` | `array` of [NxPatch](#nxpatch) | Array with patches. |
| `qChildren` | `array` of [NxPatches](#nxpatches) | Array with child objects and their patches. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qPatches`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qChildren`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCyclicGroupStates`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `CyclicGroupPosition` | [CyclicGroupPosition](#cyclicgroupposition) | |
Properties of `CyclicGroupPosition`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qActiveField` | `integer` | Active field of the cyclic group, identified by a zero-based index. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qGroupStates`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `GroupState` | [GroupState](#groupstate) | |
Properties of `GroupState`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qActiveFieldDef` | `string` | String defining the active field. |
Properties of `qInfo`
_Properties truncated due to depth limit._
---
### NxCalcCond
| Name | Type | Description |
| --- | --- | --- |
| `qCond` | [ValueExpr](#valueexpr) | |
| `qMsg` | [StringExpr](#stringexpr) | |
Properties of `qCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qMsg`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
---
### NxCardinalities
| Name | Type | Description |
| --- | --- | --- |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qHypercubeCardinal` | `integer` | Number of distinct hypercube values. |
| `qAllValuesCardinal` | `integer` | Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure. |
---
### NxCell
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. This parameter is optional. |
| `qNum` | `number` | A value. This parameter is optional. |
| `qElemNumber` | `integer` | Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values: * -1: the cell is a _Total_ cell. It shows a total. * -2: the cell is a _Null_ cell. * -3: the cell belongs to the group _Others_ . * -4: the cell is empty. Applies to pivot tables. |
| `qState` | oneOf(L \| S \| O \| D \| A \| X \| XS \| XL \| NSTATES) | |
| `qIsEmpty` | `boolean` | Is set to _true_ , if **qText** and **qNum** are empty. This parameter is optional. The default value is _false_ . |
| `qIsTotalCell` | `boolean` | Is set to _true_ if a total is displayed in the cell. This parameter is optional. The default value is _false_ . Not applicable to list objects. |
| `qIsOtherCell` | `boolean` | Is set to _true_ if the cell belongs to the group _Others_ . Dimension values can be set as _Others_ depending on what has been defined in **OtherTotalSpecProp** . This parameter is optional. The default value is _false_ . Not applicable to list objects. |
| `qFrequency` | `string` | Frequency of the value. This parameter is optional. |
| `qHighlightRanges` | [NxHighlightRanges](#nxhighlightranges) | |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
| `qIsNull` | `boolean` | Is set to _true_ if the value is Null. |
| `qMiniChart` | [NxMiniChartData](#nxminichartdata) | |
| `qInExtRow` | `boolean` | |
Properties of `qState`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `L` | `object` | LOCKED |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | SELECTED |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `O` | `object` | OPTION |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DESELECTED |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ALTERNATIVE |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `X` | `object` | EXCLUDED |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `XS` | `object` | EXCL_SELECTED |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `XL` | `object` | EXCL_LOCKED |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `NSTATES` | `object` | |
Properties of `qHighlightRanges`
| Name | Type | Description |
| --- | --- | --- |
| `qRanges` | `array` of [CharRange](#charrange) | Ranges of highlighted values. |
Properties of `qRanges`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `CharRange` | [CharRange](#charrange) | |
Properties of `CharRange`
_Properties truncated due to depth limit._
Properties of `qAttrExps`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleValue](#nxsimplevalue) | List of attribute expressions values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleValue` | [NxSimpleValue](#nxsimplevalue) | |
Properties of `NxSimpleValue`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleDimValue](#nxsimpledimvalue) | List of values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleDimValue` | [NxSimpleDimValue](#nxsimpledimvalue) | |
Properties of `NxSimpleDimValue`
_Properties truncated due to depth limit._
Properties of `qMiniChart`
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxMiniChartRows](#nxminichartrows) | Array of data. |
| `qMin` | `number` | |
| `qMax` | `number` | |
| `qError` | [NxValidationError](#nxvalidationerror) | |
Properties of `qMatrix`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMiniChartRows` | [NxMiniChartRows](#nxminichartrows) | |
Properties of `NxMiniChartRows`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
---
### NxCellPosition
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | Position of the cell on the x-axis. |
| `qy` | `integer` | Position of the cell on the y-axis. |
---
### NxCellRows
| Name | Type | Description |
| --- | --- | --- |
| `NxCellRows` | `array` of [NxCell](#nxcell) | |
Properties of `NxCellRows`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxCell` | [NxCell](#nxcell) | |
Properties of `NxCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. This parameter is optional. |
| `qNum` | `number` | A value. This parameter is optional. |
| `qElemNumber` | `integer` | Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values: * -1: the cell is a _Total_ cell. It shows a total. * -2: the cell is a _Null_ cell. * -3: the cell belongs to the group _Others_ . * -4: the cell is empty. Applies to pivot tables. |
| `qState` | oneOf(L \| S \| O \| D \| A \| X \| XS \| XL \| NSTATES) | |
| `qIsEmpty` | `boolean` | Is set to _true_ , if **qText** and **qNum** are empty. This parameter is optional. The default value is _false_ . |
| `qIsTotalCell` | `boolean` | Is set to _true_ if a total is displayed in the cell. This parameter is optional. The default value is _false_ . Not applicable to list objects. |
| `qIsOtherCell` | `boolean` | Is set to _true_ if the cell belongs to the group _Others_ . Dimension values can be set as _Others_ depending on what has been defined in **OtherTotalSpecProp** . This parameter is optional. The default value is _false_ . Not applicable to list objects. |
| `qFrequency` | `string` | Frequency of the value. This parameter is optional. |
| `qHighlightRanges` | [NxHighlightRanges](#nxhighlightranges) | |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
| `qIsNull` | `boolean` | Is set to _true_ if the value is Null. |
| `qMiniChart` | [NxMiniChartData](#nxminichartdata) | |
| `qInExtRow` | `boolean` | |
Properties of `qState`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
Properties of `qHighlightRanges`
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qMiniChart`
_Properties truncated due to depth limit._
---
### NxContainerEntry
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### NxContinuousDataOptions
| Name | Type | Description |
| --- | --- | --- |
| `qStart` | `number` | Start value. |
| `qEnd` | `number` | End value. |
| `qNbrPoints` | `integer` | Number of bins for binning. |
| `qMaxNbrTicks` | `integer` | Maximum number of ticks. |
| `qMaxNumberLines` | `integer` | Maximum number of lines. |
---
### NxContinuousMode
| Name | Type | Description |
| --- | --- | --- |
| `NxContinuousMode` | oneOf(Never \| Possible \| Time) | |
Properties of `NxContinuousMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Never` | `object` | CONTINUOUS_NEVER |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `Possible` | `object` | CONTINUOUS_IF_POSSIBLE |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `Time` | `object` | CONTINUOUS_IF_TIME |
---
### NxContinuousRangeSelectInfo
| Name | Type | Description |
| --- | --- | --- |
| `qRange` | [Range](#range) | |
| `qDimIx` | `integer` | Dimension index. |
Properties of `qRange`
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Lowest value in the range |
| `qMax` | `number` | Highest value in the range |
| `qMinInclEq` | `boolean` | If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 1 is included in the range of selections. |
| `qMaxInclEq` | `boolean` | If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 10 is included in the range of selections. |
---
### NxCurrentSelectionItem
| Name | Type | Description |
| --- | --- | --- |
| `qTotal` | `integer` | Number of values in the field. |
| `qIsNum` | `boolean` | This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional. |
| `qField` | `string` | Name of the field that is selected. |
| `qLocked` | `boolean` | This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional. |
| `qOneAndOnlyOne` | `boolean` | This parameter is displayed if its value is true. Property that is set to a field. Is set to true if the field cannot be unselected. This parameter is optional. |
| `qTextSearch` | `string` | Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional. |
| `qSelectedCount` | `integer` | Number of values that are selected. |
| `qSelected` | `string` | Values that are selected. |
| `qRangeInfo` | `array` of [RangeSelectInfo](#rangeselectinfo) | Information about the range of selected values. Is empty if there is no range of selected values. |
| `qSortIndex` | `integer` | Sort index of the field. Indexing starts from 0. |
| `qStateCounts` | [NxStateCounts](#nxstatecounts) | |
| `qSelectedFieldSelectionInfo` | `array` of [NxFieldSelectionInfo](#nxfieldselectioninfo) | Information about the fields that are selected. |
| `qNotSelectedFieldSelectionInfo` | `array` of [NxFieldSelectionInfo](#nxfieldselectioninfo) | Information about the fields that are not selected. |
| `qSelectionThreshold` | `integer` | Maximum values to show in the current selections. The default value is 6. |
| `qReadableName` | `string` | Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly. |
| `qIsHidden` | `boolean` | Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden. |
| `qDimensionReferences` | `array` of [DimensionReference](#dimensionreference) | List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem. |
Properties of `qRangeInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `RangeSelectInfo` | [RangeSelectInfo](#rangeselectinfo) | |
Properties of `RangeSelectInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qRangeLo` | `number` | Lowest value in the range. |
| `qRangeHi` | `number` | Highest value in the range. |
| `qMeasure` | `string` | Label of the measure. |
Properties of `qStateCounts`
| Name | Type | Description |
| --- | --- | --- |
| `qLocked` | `integer` | Number of values in locked state. |
| `qSelected` | `integer` | Number of values in selected state. |
| `qOption` | `integer` | Number of values in optional state. |
| `qDeselected` | `integer` | Number of values in deselected state. |
| `qAlternative` | `integer` | Number of values in alternative state. |
| `qExcluded` | `integer` | Number of values in excluded state. |
| `qSelectedExcluded` | `integer` | Number of values in selected excluded state. |
| `qLockedExcluded` | `integer` | Number of values in locked excluded state. |
Properties of `qSelectedFieldSelectionInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxFieldSelectionInfo` | [NxFieldSelectionInfo](#nxfieldselectioninfo) | |
Properties of `NxFieldSelectionInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qFieldSelectionMode` | oneOf(NORMAL \| AND \| NOT) | |
Properties of `qFieldSelectionMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qNotSelectedFieldSelectionInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxFieldSelectionInfo` | [NxFieldSelectionInfo](#nxfieldselectioninfo) | |
Properties of `NxFieldSelectionInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qFieldSelectionMode` | oneOf(NORMAL \| AND \| NOT) | |
Properties of `qFieldSelectionMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qDimensionReferences`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `DimensionReference` | [DimensionReference](#dimensionreference) | The DimensionReference structure points to a GenericDimension. |
Properties of `DimensionReference`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the associated dimension. |
| `qLabel` | `string` | Text label. |
---
### NxDataAreaPage
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `number` | Position from the left. Corresponds to the lowest possible value of the first measure (the measure on the x-axis). |
| `qTop` | `number` | Position from the top. Corresponds to the highest possible value of the second measure (the measure on the y-axis). |
| `qWidth` | `number` | Width of the page. Corresponds to the highest possible value of the first measure (the measure on the x-axis). |
| `qHeight` | `number` | Height of the page. The difference between _qTop_ and _qHeight_ gives the lowest possible value of the second measure (the measure on the y-axis). |
---
### NxDataPage
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxCellRows](#nxcellrows) | Array of data. |
| `qTails` | `array` of [NxGroupTail](#nxgrouptail) | Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty _[ ]_ . |
| `qArea` | [Rect](#rect) | |
| `qIsReduced` | `boolean` | Is set to true, if the data have been reduced. The default value is false. |
Properties of `qMatrix`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxCellRows` | [NxCellRows](#nxcellrows) | |
Properties of `NxCellRows`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxCell` | [NxCell](#nxcell) | |
Properties of `NxCell`
_Properties truncated due to depth limit._
Properties of `qTails`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxGroupTail` | [NxGroupTail](#nxgrouptail) | |
Properties of `NxGroupTail`
| Name | Type | Description |
| --- | --- | --- |
| `qUp` | `integer` | Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . Is not shown if the value is 0. This parameter is optional. |
| `qDown` | `integer` | Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ Is not shown if the value is 0. This parameter is optional. |
Properties of `qArea`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
---
### NxDataReductionMode
| Name | Type | Description |
| --- | --- | --- |
| `NxDataReductionMode` | oneOf(N \| D1 \| S \| C \| ST) | |
Properties of `NxDataReductionMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | DATA_REDUCTION_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `D1` | `object` | DATA_REDUCTION_ONEDIM |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | DATA_REDUCTION_SCATTERED |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | DATA_REDUCTION_CLUSTERED |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `ST` | `object` | DATA_REDUCTION_STACKED |
---
### NxDerivedField
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the derived field. The identifier is unique. |
| `qName` | `string` | Combination of field name, definition and method. Example: _OrderDate.MyDefinition.Year_ |
| `qMethod` | `string` | Method name associated to the derived field. |
| `qExpr` | `string` | Expression of the derived field. Example: If _qName_ is _OrderDate.MyDefinition.Year_ , the expression is as follows: _=${Mydefinition(OrderDate).Year}_ |
| `qTags` | `array of string` | List of tags. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxDerivedFieldDescriptionList
| Name | Type | Description |
| --- | --- | --- |
| `qDerivedFieldLists` | `array` of [NxDerivedFieldsData](#nxderivedfieldsdata) | Information about the derived fields. |
Properties of `qDerivedFieldLists`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDerivedFieldsData` | [NxDerivedFieldsData](#nxderivedfieldsdata) | |
Properties of `NxDerivedFieldsData`
| Name | Type | Description |
| --- | --- | --- |
| `qDerivedDefinitionName` | `string` | Name of the derived definition. |
| `qFieldDefs` | `array` of [NxDerivedField](#nxderivedfield) | List of the derived fields. |
| `qGroupDefs` | `array` of [NxDerivedGroup](#nxderivedgroup) | List of the derived groups. |
| `qTags` | `array of string` | List of tags on the derived fields. |
Properties of `qFieldDefs`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qGroupDefs`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
---
### NxDerivedFieldsData
| Name | Type | Description |
| --- | --- | --- |
| `qDerivedDefinitionName` | `string` | Name of the derived definition. |
| `qFieldDefs` | `array` of [NxDerivedField](#nxderivedfield) | List of the derived fields. |
| `qGroupDefs` | `array` of [NxDerivedGroup](#nxderivedgroup) | List of the derived groups. |
| `qTags` | `array of string` | List of tags on the derived fields. |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDerivedField` | [NxDerivedField](#nxderivedfield) | |
Properties of `NxDerivedField`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the derived field. The identifier is unique. |
| `qName` | `string` | Combination of field name, definition and method. Example: _OrderDate.MyDefinition.Year_ |
| `qMethod` | `string` | Method name associated to the derived field. |
| `qExpr` | `string` | Expression of the derived field. Example: If _qName_ is _OrderDate.MyDefinition.Year_ , the expression is as follows: _=${Mydefinition(OrderDate).Year}_ |
| `qTags` | `array of string` | List of tags. |
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qGroupDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDerivedGroup` | [NxDerivedGroup](#nxderivedgroup) | |
Properties of `NxDerivedGroup`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the group. |
| `qName` | `string` | Name of the derived group. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | List of the derived fields in the group. |
Properties of `qGrouping`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qFieldDefs`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxDerivedGroup
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the group. |
| `qName` | `string` | Name of the derived group. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | List of the derived fields in the group. |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxDimCellType
| Name | Type | Description |
| --- | --- | --- |
| `NxDimCellType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
Properties of `NxDimCellType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | NX_DIM_CELL_VALUE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `E` | `object` | NX_DIM_CELL_EMPTY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIM_CELL_NORMAL |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIM_CELL_TOTAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `O` | `object` | NX_DIM_CELL_OTHER |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_DIM_CELL_AGGR |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | NX_DIM_CELL_PSEUDO |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | NX_DIM_CELL_ROOT |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | NX_DIM_CELL_NULL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `G` | `object` | NX_DIM_CELL_GENERATED |
---
### NxDimension
The fields or expressions in the dimension are either defined in **qDef** or in the master dimension referred to by **qLibraryId**. If **qLibraryId** is set then the qFieldDefs, qFieldLabels, qGrouping, qLabelExpression and qAlias of the master dimension will be used.
If the dimension is set in the hypercube and not in the library, this dimension cannot be shared with other objects.
A dimension that is set in the library can be used by many objects.
| Name | Type | Description |
| --- | --- | --- |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qDef` | [NxInlineDimensionDef](#nxinlinedimensiondef) | |
| `qNullSuppression` | `boolean` | If set to true, no null values are returned. |
| `qIncludeElemValue` | `boolean` | |
| `qOtherTotalSpec` | [OtherTotalSpecProp](#othertotalspecprop) | |
| `qShowTotal` | `boolean` | |
| `qShowAll` | `boolean` | If set to true, all dimension values are shown. |
| `qOtherLabel` | [StringExpr](#stringexpr) | |
| `qTotalLabel` | [StringExpr](#stringexpr) | |
| `qCalcCond` | [ValueExpr](#valueexpr) | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qAttributeDimensions` | `array` of [NxAttrDimDef](#nxattrdimdef) | List of attribute dimensions. |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
Properties of `qDef`
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional. |
| `qFieldLabels` | `array of string` | Array of field labels. This parameter is optional. |
| `qSortCriterias` | `array` of [SortCriteria](#sortcriteria) | Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional. |
| `qNumberPresentations` | `array` of [FieldAttributes](#fieldattributes) | Defines the format of the value. This parameter is optional. |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qActiveField` | `integer` | Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( _qGrouping_ is C). |
| `qLabelExpression` | `string` | Label expression. This parameter is optional. |
| `qAlias` | `string` | Alias of the dimension. |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSortCriterias`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SortCriteria` | [SortCriteria](#sortcriteria) | |
Properties of `SortCriteria`
_Properties truncated due to depth limit._
Properties of `qNumberPresentations`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldAttributes` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
Properties of `FieldAttributes`
_Properties truncated due to depth limit._
Properties of `qOtherTotalSpec`
| Name | Type | Description |
| --- | --- | --- |
| `qOtherMode` | oneOf(OTHER_OFF \| OTHER_COUNTED \| OTHER_ABS_LIMITED \| OTHER_ABS_ACC_TARGET \| OTHER_REL_LIMITED \| OTHER_REL_ACC_TARGET) | |
| `qOtherCounted` | [ValueExpr](#valueexpr) | |
| `qOtherLimit` | [ValueExpr](#valueexpr) | |
| `qOtherLimitMode` | oneOf(OTHER_GE_LIMIT \| OTHER_LE_LIMIT \| OTHER_GT_LIMIT \| OTHER_LT_LIMIT) | |
| `qSuppressOther` | `boolean` | If set to true, the group _Others_ is not displayed as a dimension value. The default value is false. |
| `qForceBadValueKeeping` | `boolean` | This parameter is used when _qOtherMode_ is set to: * OTHER_ABS_LIMITED * OTHER_REL_LIMITED * OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true. |
| `qApplyEvenWhenPossiblyWrongResult` | `boolean` | Set this parameter to true to allow the calculation of _Others_ even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true. |
| `qGlobalOtherGrouping` | `boolean` | This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false. |
| `qOtherCollapseInnerDimensions` | `boolean` | If set to true, it collapses the inner dimensions (if any) in the group _Others_ . The default value is false. |
| `qOtherSortMode` | oneOf(OTHER_SORT_DEFAULT \| OTHER_SORT_DESCENDING \| OTHER_SORT_ASCENDING) | |
| `qTotalMode` | oneOf(TOTAL_OFF \| TOTAL_EXPR) | |
| `qReferencedExpression` | [StringExpr](#stringexpr) | |
Properties of `qOtherMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_COUNTED` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_LIMITED` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_ACC_TARGET` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_LIMITED` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_ACC_TARGET` | `object` | |
Properties of `qOtherCounted`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherLimit`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherLimitMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GE_LIMIT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LE_LIMIT` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GT_LIMIT` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LT_LIMIT` | `object` | |
Properties of `qOtherSortMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DEFAULT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DESCENDING` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_ASCENDING` | `object` | |
Properties of `qTotalMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_EXPR` | `object` | |
Properties of `qReferencedExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qOtherLabel`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qTotalLabel`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qCalcCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qAttributeExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprDef` | [NxAttrExprDef](#nxattrexprdef) | |
Properties of `NxAttrExprDef`
| Name | Type | Description |
| --- | --- | --- |
| `qExpression` | `string` | Definition of the attribute expression. Example: _"Max(OrderID)"_ |
| `qLibraryId` | `string` | Definition of the attribute expression stored in the library. Example: _"MyGenericMeasure"_ |
| `qAttribute` | `boolean` | If set to true, this measure will not affect the number of rows in the cube. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qLabel` | `string` | Label of the attribute expression. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qAttributeDimensions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrDimDef` | [NxAttrDimDef](#nxattrdimdef) | Layout for _NxAttrDimDef_. |
Properties of `NxAttrDimDef`
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | `string` | Expression or field name. |
| `qLibraryId` | `string` | LibraryId for dimension. |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qAttribute` | `boolean` | If set to true, this attribute will not affect the number of rows in the cube. |
Properties of `qSortBy`
_Properties truncated due to depth limit._
Properties of `qCalcCondition`
| Name | Type | Description |
| --- | --- | --- |
| `qCond` | [ValueExpr](#valueexpr) | |
| `qMsg` | [StringExpr](#stringexpr) | |
Properties of `qCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qMsg`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
---
### NxDimensionInfo
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qLocked` | `boolean` | Is set to true if the field is locked. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qGroupFallbackTitles` | `array of string` | Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group). |
| `qGroupPos` | `integer` | Index of the dimension that is currently in use. _qGroupPos_ is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups. |
| `qStateCounts` | [NxStateCounts](#nxstatecounts) | |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qDimensionType` | oneOf(D \| N \| T) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's definition. |
| `qGroupFieldDefs` | `array of string` | Array of field names. |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qContinuousAxes` | `boolean` | Is continuous axis used. |
| `qIsCyclic` | `boolean` | Is a cyclic dimension used. |
| `qDerivedField` | `boolean` | Is derived field is used as a dimension. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | Array of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | Array of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
| `qIsOneAndOnlyOne` | `boolean` | If set to true, it means that the field always has one and only one selected value. |
| `qCardinalities` | [NxCardinalities](#nxcardinalities) | |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qEffectiveDimensionName` | `string` | The expanded and stripped dimension name used internally in engine. |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_SORT_INDICATE_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_SORT_INDICATE_ASC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_SORT_INDICATE_DESC |
Properties of `qGroupFallbackTitles`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qStateCounts`
| Name | Type | Description |
| --- | --- | --- |
| `qLocked` | `integer` | Number of values in locked state. |
| `qSelected` | `integer` | Number of values in selected state. |
| `qOption` | `integer` | Number of values in optional state. |
| `qDeselected` | `integer` | Number of values in deselected state. |
| `qAlternative` | `integer` | Number of values in alternative state. |
| `qExcluded` | `integer` | Number of values in excluded state. |
| `qSelectedExcluded` | `integer` | Number of values in selected excluded state. |
| `qLockedExcluded` | `integer` | Number of values in locked excluded state. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
Properties of `qDimensionType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_DIMENSION_TYPE_DISCRETE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIMENSION_TYPE_NUMERIC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIMENSION_TYPE_TIME |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
Properties of `qGroupFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qAttrExprInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprInfo` | [NxAttrExprInfo](#nxattrexprinfo) | Layout for _NxAttrExprDef_. |
Properties of `NxAttrExprInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qFallbackTitle` | `string` | |
| `qMinText` | `string` | String version of the minimum Value. |
| `qMaxText` | `string` | String version of the maximum Value. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrDimInfo` | [NxAttrDimInfo](#nxattrdiminfo) | Layout for _NxAttrDimDef_. |
Properties of `NxAttrDimInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qCardinal` | `integer` | Cardinality of the attribute expression. |
| `qSize` | [Size](#size) | |
| `qFallbackTitle` | `string` | The title for the attribute dimension. |
| `qLocked` | `boolean` | The Locked value of the dimension. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
Properties of `qSize`
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qCardinalities`
| Name | Type | Description |
| --- | --- | --- |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qHypercubeCardinal` | `integer` | Number of distinct hypercube values. |
| `qAllValuesCardinal` | `integer` | Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure. |
---
### NxDimensionType
| Name | Type | Description |
| --- | --- | --- |
| `NxDimensionType` | oneOf(D \| N \| T) | |
Properties of `NxDimensionType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_DIMENSION_TYPE_DISCRETE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIMENSION_TYPE_NUMERIC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIMENSION_TYPE_TIME |
---
### NxDownloadInfo
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | URL to download the reduced app on. |
| `qFileSize` | `integer` | The filesize of the reduced app. |
---
### NxDownloadOptions
| Name | Type | Description |
| --- | --- | --- |
| `qBookmarkId` | `string` | Bookmark Id to apply before reducing the application. |
| `qExpires` | `integer` | Time in seconds for how long the download link is valid. |
| `qServeOnce` | `boolean` | |
---
### NxEngineVersion
| Name | Type | Description |
| --- | --- | --- |
| `qComponentVersion` | `string` | Version number of the Qlik engine component. |
---
### NxExportFileType
| Name | Type | Description |
| --- | --- | --- |
| `NxExportFileType` | oneOf(CSV_C \| CSV_T \| OOXML \| PARQUET) | |
Properties of `NxExportFileType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `CSV_C` | `object` | EXPORT_CSV_C |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `CSV_T` | `object` | EXPORT_CSV_T |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OOXML` | `object` | EXPORT_OOXML |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `PARQUET` | `object` | EXPORT_PARQUET |
---
### NxExportState
| Name | Type | Description |
| --- | --- | --- |
| `NxExportState` | oneOf(P \| A) | |
Properties of `NxExportState`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | EXPORT_POSSIBLE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | EXPORT_ALL |
---
### NxFeature
| Name | Type | Description |
| --- | --- | --- |
| `NxFeature` | oneOf(binningData \| bookmarks \| calculatedFields \| continuousData \| invertedSelections \| rangeSelections \| reducingData \| search \| selectionCount \| selectionInsights \| tableMiniChart \| trendlines \| calculatedDimensions \| includeZeroValues \| includeNullValues \| filterPanePaging \| filterPaneCustomSorting \| showFrequency \| limitation \| totals) | |
Properties of `NxFeature`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `binningData` | `object` | FEATURE_BINNING_DATA |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `bookmarks` | `object` | FEATURE_BOOKMARKS |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `calculatedFields` | `object` | FEATURE_CALCULATED_FIELDS |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `continuousData` | `object` | FEATURE_CONTINUOUS_DATA |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `invertedSelections` | `object` | FEATURE_INVERTED_SELECTIONS |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `rangeSelections` | `object` | FEATURE_RANGE_SELECTIONS |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `reducingData` | `object` | FEATURE_REDUCING_DATA |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `search` | `object` | FEATURE_SEARCH |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `selectionCount` | `object` | FEATURE_SELECTION_COUNT |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `selectionInsights` | `object` | FEATURE_SELECTION_INSIGHTS |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `tableMiniChart` | `object` | FEATURE_TABLE_MINI_CHART |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `trendlines` | `object` | FEATURE_TRENDLINES |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `calculatedDimensions` | `object` | FEATURE_CALCULATED_DIMENSIONS |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `includeZeroValues` | `object` | FEATURE_INCLUDE_ZERO_VALUES |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `includeNullValues` | `object` | FEATURE_INCLUDE_NULL_VALUES |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `filterPanePaging` | `object` | FEATURE_FILTER_PANE_PAGING |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `filterPaneCustomSorting` | `object` | FEATURE_FILTER_PANE_CUSTOM_SORTING |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `showFrequency` | `object` | FEATURE_SHOW_FREQUENCY |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `limitation` | `object` | FEATURE_LIMITATION |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `totals` | `object` | FEATURE_TOTALS |
---
### NxFieldDescription
**NxDerivedFieldsdata**
| Name |
Description |
Type |
| qDerivedDefinitionName |
Name of the derived definition. |
String |
| qFieldDefs |
List of the derived fields. |
Array of NxDerivedField |
| qGroupDefs |
List of the derived groups. |
Array of NxDerivedGroup |
| qTags |
List of tags on the derived fields. |
Array of String |
| Name | Type | Description |
| --- | --- | --- |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qIsHidden` | `boolean` | If set to true, it means that the field is hidden. |
| `qIsSystem` | `boolean` | If set to true, it means that the field is a system field. |
| `qAndMode` | `boolean` | If set to true a logical AND (instead of a logical OR) is used when making selections in a field. The default value is false. |
| `qName` | `string` | Name of the field |
| `qCardinal` | `integer` | Number of distinct field values |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qIsDefinitionOnly` | `boolean` | If set to true, it means that the field is a field on the fly. |
| `qDerivedFieldData` | [NxDerivedFieldDescriptionList](#nxderivedfielddescriptionlist) | |
| `qIsDetail` | `boolean` | Is used for Direct Discovery. If set to true, it means that the type of the field is detail. |
| `qIsImplicit` | `boolean` | Is used for Direct Discovery. If set to true, it means that the type of the field is measure. |
| `qReadableName` | `string` | |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qDerivedFieldData`
| Name | Type | Description |
| --- | --- | --- |
| `qDerivedFieldLists` | `array` of [NxDerivedFieldsData](#nxderivedfieldsdata) | Information about the derived fields. |
Properties of `qDerivedFieldLists`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxDerivedFieldsData` | [NxDerivedFieldsData](#nxderivedfieldsdata) | |
Properties of `NxDerivedFieldsData`
_Properties truncated due to depth limit._
---
### NxFieldProperties
| Name | Type | Description |
| --- | --- | --- |
| `qOneAndOnlyOne` | `boolean` | This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The property _OneAndOnlyOne_ can be set to true if one and only value has been selected in the field prior to setting the property.
|
---
### NxFieldResourceId
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field to get the resource id for. |
| `qResourceIds` | `array` of [NxFieldTableResourceId](#nxfieldtableresourceid) | Field level resource Id per table that the field is part of |
Properties of `qResourceIds`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxFieldTableResourceId` | [NxFieldTableResourceId](#nxfieldtableresourceid) | |
Properties of `NxFieldTableResourceId`
| Name | Type | Description |
| --- | --- | --- |
| `qTable` | `string` | Name of the table that the field belongs to get the resource id for |
| `qResourceId` | `string` | Resource identifier for the field |
---
### NxFieldSelectionInfo
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qFieldSelectionMode` | oneOf(NORMAL \| AND \| NOT) | |
Properties of `qFieldSelectionMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NORMAL` | `object` | SELECTION_MODE_NORMAL |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `AND` | `object` | SELECTION_MODE_AND |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT` | `object` | SELECTION_MODE_NOT |
---
### NxFieldSelectionMode
| Name | Type | Description |
| --- | --- | --- |
| `NxFieldSelectionMode` | oneOf(NORMAL \| AND \| NOT) | |
Properties of `NxFieldSelectionMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `NORMAL` | `object` | SELECTION_MODE_NORMAL |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `AND` | `object` | SELECTION_MODE_AND |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `NOT` | `object` | SELECTION_MODE_NOT |
---
### NxFieldTableResourceId
| Name | Type | Description |
| --- | --- | --- |
| `qTable` | `string` | Name of the table that the field belongs to get the resource id for |
| `qResourceId` | `string` | Resource identifier for the field |
---
### NxFrequencyMode
| Name | Type | Description |
| --- | --- | --- |
| `NxFrequencyMode` | oneOf(N \| V \| P \| R) | |
Properties of `NxFrequencyMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_FREQUENCY_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | NX_FREQUENCY_VALUE |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | NX_FREQUENCY_PERCENT |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | NX_FREQUENCY_RELATIVE |
---
### NxGetBookmarkOptions
| Name | Type | Description |
| --- | --- | --- |
| `qTypes` | `array of string` | List of object types. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
| `qIncludePatches` | `boolean` | Include the bookmark patches. Patches can be very large and may make the list result unmanageable. |
Properties of `qTypes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxGetObjectOptions
| Name | Type | Description |
| --- | --- | --- |
| `qTypes` | `array of string` | List of object types. |
| `qIncludeSessionObjects` | `boolean` | Set to true to include session objects. The default value is false. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
Properties of `qTypes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxGroupDef
Defines the properties of an object group.
| Name | Type | Description |
| --- | --- | --- |
| `qClass` | oneOf(bookmark \| object) | |
| `qObjectType` | `string` | Specifies the type of the group's object members. |
| `qGroupType` | `string` | Specifies the type of the group's subgroup members. |
| `qLabel` | `string` | The group's label. Will be evaluated as an expression if it starts with '='. |
| `qIncludeOrphanGroups` | `boolean` | Include all groups of the relevant type, by adding those groups last that are not explicitly included in the hierarchy (orphans) |
| `qMemberIds` | `array` of [NxGroupObjectId](#nxgroupobjectid) | The objects and sub-groups that are members of the group. |
Properties of `qClass`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `bookmark` | `object` | MEMBER_BOOKMARK |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `object` | `object` | MEMBER_OBJECT |
Properties of `qMemberIds`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxGroupObjectId` | [NxGroupObjectId](#nxgroupobjectid) | Holds the ID of a _NxGroupDef_'s member. _GroupId_ holds the ID of a sub-group while _ObjectId_ holds the ID of an object. Only one Id should be set. _GroupId_ takes precedence if both are set. |
Properties of `NxGroupObjectId`
| Name | Type | Description |
| --- | --- | --- |
| `qGroupId` | `string` | |
| `qObjectId` | `string` | |
---
### NxGroupMemberClass
| Name | Type | Description |
| --- | --- | --- |
| `NxGroupMemberClass` | oneOf(bookmark \| object) | |
Properties of `NxGroupMemberClass`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `bookmark` | `object` | MEMBER_BOOKMARK |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `object` | `object` | MEMBER_OBJECT |
---
### NxGroupObjectId
Holds the ID of a _NxGroupDef_'s member.
_GroupId_ holds the ID of a sub-group while _ObjectId_ holds the ID of an object.
Only one Id should be set. _GroupId_ takes precedence if both are set.
| Name | Type | Description |
| --- | --- | --- |
| `qGroupId` | `string` | |
| `qObjectId` | `string` | |
---
### NxGroupTail
| Name | Type | Description |
| --- | --- | --- |
| `qUp` | `integer` | Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . Is not shown if the value is 0. This parameter is optional. |
| `qDown` | `integer` | Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ Is not shown if the value is 0. This parameter is optional. |
---
### NxGrpType
| Name | Type | Description |
| --- | --- | --- |
| `NxGrpType` | oneOf(N \| H \| C) | |
Properties of `NxGrpType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
---
### NxHighlightRanges
| Name | Type | Description |
| --- | --- | --- |
| `qRanges` | `array` of [CharRange](#charrange) | Ranges of highlighted values. |
Properties of `qRanges`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `CharRange` | [CharRange](#charrange) | |
Properties of `CharRange`
| Name | Type | Description |
| --- | --- | --- |
| `qCharPos` | `integer` | Position of the first search occurrence. |
| `qCharCount` | `integer` | Number of occurrences found. |
---
### NxHypercubeMode
| Name | Type | Description |
| --- | --- | --- |
| `NxHypercubeMode` | oneOf(S \| P \| K \| T \| D) | |
Properties of `NxHypercubeMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | DATA_MODE_STRAIGHT |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | DATA_MODE_PIVOT |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `K` | `object` | DATA_MODE_PIVOT_STACK |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | DATA_MODE_TREE |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATA_MODE_DYNAMIC |
---
### NxInfo
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### NxInlineDimensionDef
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional. |
| `qFieldLabels` | `array of string` | Array of field labels. This parameter is optional. |
| `qSortCriterias` | `array` of [SortCriteria](#sortcriteria) | Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional. |
| `qNumberPresentations` | `array` of [FieldAttributes](#fieldattributes) | Defines the format of the value. This parameter is optional. |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qActiveField` | `integer` | Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( _qGrouping_ is C). |
| `qLabelExpression` | `string` | Label expression. This parameter is optional. |
| `qAlias` | `string` | Alias of the dimension. |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSortCriterias`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SortCriteria` | [SortCriteria](#sortcriteria) | |
Properties of `SortCriteria`
| Name | Type | Description |
| --- | --- | --- |
| `qSortByState` | `integer` | Sorts the field values according to their logical state (selected, optional, alternative or excluded). |
| `qSortByFrequency` | `integer` | Sorts the field values by frequency (number of occurrences in the field). |
| `qSortByNumeric` | `integer` | Sorts the field values by numeric value. |
| `qSortByAscii` | `integer` | Sorts the field by alphabetical order. |
| `qSortByLoadOrder` | `integer` | Sorts the field values by the initial load order. |
| `qSortByExpression` | `integer` | Sorts the field by expression. |
| `qExpression` | [ValueExpr](#valueexpr) | |
| `qSortByGreyness` | `integer` | |
Properties of `qExpression`
_Properties truncated due to depth limit._
Properties of `qNumberPresentations`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldAttributes` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
Properties of `FieldAttributes`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
---
### NxInlineMeasureDef
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | Name of the measure. An empty string is returned as a default value. This parameter is optional. |
| `qDescription` | `string` | Description of the measure. An empty string is returned as a default value. This parameter is optional. |
| `qTags` | `array of string` | Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qDef` | `string` | Definition of the expression in the measure. Example: _Sum (OrderTotal)_ This parameter is mandatory. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qRelative` | `boolean` | If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional. |
| `qBrutalSum` | `boolean` | If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to **Expression Total** . |
| `qAggrFunc` | `string` | 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. |
| `qAccumulate` | `integer` | * 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the _qAccumulate_ value Default value is 0. This parameter is optional. |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qActiveExpression` | `integer` | Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional. |
| `qExpressions` | `array of string` | Array of expressions. This parameter is used in case of cyclic measures ( _qGrouping_ is C). List of the expressions in the cyclic group. |
| `qLabelExpression` | `string` | Label expression. This parameter is optional. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxLTrendlineType
| Name | Type | Description |
| --- | --- | --- |
| `NxLTrendlineType` | oneOf(AVERAGE \| LINEAR \| POLYNOMIAL2 \| POLYNOMIAL3 \| POLYNOMIAL4 \| EXPONENTIAL \| POWER \| LOG) | |
Properties of `NxLTrendlineType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `AVERAGE` | `object` | Average |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LINEAR` | `object` | Linear |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL2` | `object` | Polynomial2 |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL3` | `object` | Polynomial3 |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL4` | `object` | Polynomial4 |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `EXPONENTIAL` | `object` | Exponential |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `POWER` | `object` | Power |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG` | `object` | Logarithmic |
---
### NxLayoutErrors
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. |
---
### NxLibraryDimension
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of dimension names. |
| `qFieldLabels` | `array of string` | Array of dimension labels. |
| `qLabelExpression` | `string` | |
| `qAlias` | `string` | Alias of the dimension. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxLibraryDimensionDef
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of dimension names. |
| `qFieldLabels` | `array of string` | Array of dimension labels. |
| `qLabelExpression` | `string` | |
| `qAlias` | `string` | Alias of the dimension. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxLibraryMeasure
Information about the library measure. Is the layout for _NxLibraryMeasureDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | |
| `qDef` | `string` | |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qExpressions` | `array of string` | |
| `qActiveExpression` | `integer` | |
| `qLabelExpression` | `string` | |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
---
### NxLibraryMeasureDef
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | Label of the measure. |
| `qDef` | `string` | Definition of the measure. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qExpressions` | `array of string` | Array of expressions. |
| `qActiveExpression` | `integer` | Index to the active expression in a measure. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qScriptGenerated` | `boolean` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
---
### NxLinkedObjectInfo
| Name | Type | Description |
| --- | --- | --- |
| `qRootId` | `string` | Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object. |
| `qInfo` | [NxInfo](#nxinfo) | |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### NxListObjectExpression
| Name | Type | Description |
| --- | --- | --- |
| `qExpr` | `string` | Value of the expression. |
| `qError` | [NxLayoutErrors](#nxlayouterrors) | |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. |
---
### NxListObjectExpressionDef
| Name | Type | Description |
| --- | --- | --- |
| `qExpr` | `string` | Value of the expression. |
| `qLibraryId` | `string` | Refers to an expression stored in the library. |
---
### NxLocalizedErrorCode
| Name | Type | Description |
| --- | --- | --- |
| `NxLocalizedErrorCode` | oneOf(LOCERR_INTERNAL_ERROR \| LOCERR_GENERIC_UNKNOWN \| LOCERR_GENERIC_OK \| LOCERR_GENERIC_NOT_SET \| LOCERR_GENERIC_NOT_FOUND \| LOCERR_GENERIC_ALREADY_EXISTS \| LOCERR_GENERIC_INVALID_PATH \| LOCERR_GENERIC_ACCESS_DENIED \| LOCERR_GENERIC_OUT_OF_MEMORY \| LOCERR_GENERIC_NOT_INITIALIZED \| LOCERR_GENERIC_INVALID_PARAMETERS \| LOCERR_GENERIC_EMPTY_PARAMETERS \| LOCERR_GENERIC_INTERNAL_ERROR \| LOCERR_GENERIC_CORRUPT_DATA \| LOCERR_GENERIC_MEMORY_INCONSISTENCY \| LOCERR_GENERIC_INVISIBLE_OWNER_ABORT \| LOCERR_GENERIC_PROHIBIT_VALIDATE \| LOCERR_GENERIC_ABORTED \| LOCERR_GENERIC_CONNECTION_LOST \| LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION \| LOCERR_GENERIC_REST_CONNECTION_FAILURE \| LOCERR_GENERIC_MEMORY_LIMIT_REACHED \| LOCERR_GENERIC_NOT_IMPLEMENTED \| LOCERR_GENERIC_ENGINE_TERMINATED \| LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED \| LOCERR_HTTP_400 \| LOCERR_HTTP_401 \| LOCERR_HTTP_402 \| LOCERR_HTTP_403 \| LOCERR_HTTP_404 \| LOCERR_HTTP_405 \| LOCERR_HTTP_406 \| LOCERR_HTTP_407 \| LOCERR_HTTP_408 \| LOCERR_HTTP_409 \| LOCERR_HTTP_410 \| LOCERR_HTTP_411 \| LOCERR_HTTP_412 \| LOCERR_HTTP_413 \| LOCERR_HTTP_414 \| LOCERR_HTTP_415 \| LOCERR_HTTP_416 \| LOCERR_HTTP_417 \| LOCERR_HTTP_422 \| LOCERR_HTTP_423 \| LOCERR_HTTP_429 \| LOCERR_HTTP_500 \| LOCERR_HTTP_501 \| LOCERR_HTTP_502 \| LOCERR_HTTP_503 \| LOCERR_HTTP_504 \| LOCERR_HTTP_505 \| LOCERR_HTTP_509 \| LOCERR_HTTP_COULD_NOT_RESOLVE_HOST \| LOCERR_APP_ALREADY_EXISTS \| LOCERR_APP_INVALID_NAME \| LOCERR_APP_ALREADY_OPEN \| LOCERR_APP_NOT_FOUND \| LOCERR_APP_IMPORT_FAILED \| LOCERR_APP_SAVE_FAILED \| LOCERR_APP_CREATE_FAILED \| LOCERR_APP_INVALID \| LOCERR_APP_CONNECT_FAILED \| LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE \| LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE \| LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION \| LOCERR_APP_MIGRATION_FAILURE \| LOCERR_APP_SCRIPT_MISSING \| LOCERR_APP_EXPORT_FAILED \| LOCERR_APP_SIZE_EXCEEDED \| LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED \| LOCERR_APP_NOT_OPEN \| LOCERR_APP_EVENT_SOURCE_TIMEOUT \| LOCERR_CONNECTION_ALREADY_EXISTS \| LOCERR_CONNECTION_NOT_FOUND \| LOCERR_CONNECTION_FAILED_TO_LOAD \| LOCERR_CONNECTION_FAILED_TO_IMPORT \| LOCERR_CONNECTION_NAME_IS_INVALID \| LOCERR_CONNECTION_MISSING_CREDENTIALS \| LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT \| LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE \| LOCERR_FILE_ACCESS_DENIED \| LOCERR_FILE_NAME_INVALID \| LOCERR_FILE_CORRUPT \| LOCERR_FILE_NOT_FOUND \| LOCERR_FILE_FORMAT_UNSUPPORTED \| LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE \| LOCERR_FILE_TABLE_NOT_FOUND \| LOCERR_USER_ACCESS_DENIED \| LOCERR_USER_IMPERSONATION_FAILED \| LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS \| LOCERR_SERVER_OUT_OF_SESSION_CALS \| LOCERR_SERVER_OUT_OF_USAGE_CALS \| LOCERR_SERVER_OUT_OF_CALS \| LOCERR_SERVER_OUT_OF_NAMED_CALS \| LOCERR_SERVER_OFF_DUTY \| LOCERR_SERVER_BUSY \| LOCERR_SERVER_LICENSE_EXPIRED \| LOCERR_SERVER_AJAX_DISABLED \| LOCERR_SERVER_NO_TOKEN \| LOCERR_HC_INVALID_OBJECT \| LOCERR_HC_RESULT_TOO_LARGE \| LOCERR_HC_INVALID_OBJECT_STATE \| LOCERR_HC_MODAL_OBJECT_ERROR \| LOCERR_CALC_INVALID_DEF \| LOCERR_CALC_NOT_IN_LIB \| LOCERR_CALC_HEAP_ERROR \| LOCERR_CALC_TOO_LARGE \| LOCERR_CALC_TIMEOUT \| LOCERR_CALC_EVAL_CONDITION_FAILED \| LOCERR_CALC_MIXED_LINKED_AGGREGATION \| LOCERR_CALC_MISSING_LINKED \| LOCERR_CALC_INVALID_COL_SORT \| LOCERR_CALC_PAGES_TOO_LARGE \| LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED \| LOCERR_CALC_VALIDATION_STATE_INVALID \| LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS \| LOCERR_CALC_MISSING_LINKED_FIELD \| LOCERR_CALC_NOT_CALCULATED \| LOCERR_LAYOUT_EXTENDS_INVALID_ID \| LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND \| LOCERR_LAYOUT_LINKED_OBJECT_INVALID \| LOCERR_PERSISTENCE_WRITE_FAILED \| LOCERR_PERSISTENCE_READ_FAILED \| LOCERR_PERSISTENCE_DELETE_FAILED \| LOCERR_PERSISTENCE_NOT_FOUND \| LOCERR_PERSISTENCE_UNSUPPORTED_VERSION \| LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY \| LOCERR_PERSISTENCE_MIGRATION_CANCELLED \| LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED \| LOCERR_PERSISTENCE_DISK_FULL \| LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP \| LOCERR_PERSISTENCE_MOVE_FAILED \| LOCERR_PERSISTENCE_OBJECT_LOCKED \| LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING \| LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS \| LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS \| LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED \| LOCERR_RELOAD_IN_PROGRESS \| LOCERR_RELOAD_TABLE_X_NOT_FOUND \| LOCERR_RELOAD_UNKNOWN_STATEMENT \| LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_FIELD_X_NOT_FOUND \| LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND \| LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND \| LOCERR_RELOAD_NAME_ALREADY_TAKEN \| LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF \| LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF \| LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED \| LOCERR_RELOAD_OPEN_FILE_ERROR \| LOCERR_RELOAD_AUTO_GENERATE_COUNT \| LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB \| LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR \| LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND \| LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID \| LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE \| LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE \| LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS \| LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS \| LOCERR_RELOAD_NO_OPEN_DATABASE \| LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY \| LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE \| LOCERR_RELOAD_ODBC_CONNECT_FAILED \| LOCERR_RELOAD_OLEDB_CONNECT_FAILED \| LOCERR_RELOAD_CUSTOM_CONNECT_FAILED \| LOCERR_RELOAD_ODBC_READ_FAILED \| LOCERR_RELOAD_OLEDB_READ_FAILED \| LOCERR_RELOAD_CUSTOM_READ_FAILED \| LOCERR_RELOAD_BINARY_LOAD_PROHIBITED \| LOCERR_RELOAD_CONNECTOR_START_FAILED \| LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING \| LOCERR_RELOAD_CONNECTOR_REPLY_ERROR \| LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR \| LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR \| LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS \| LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE \| LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD \| LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT \| LOCERR_RELOAD_EXIT_ERROR \| LOCERR_PERSONAL_NEW_VERSION_AVAILABLE \| LOCERR_PERSONAL_VERSION_EXPIRED \| LOCERR_PERSONAL_SECTION_ACCESS_DETECTED \| LOCERR_PERSONAL_APP_DELETION_FAILED \| LOCERR_USER_AUTHENTICATION_FAILURE \| LOCERR_EXPORT_OUT_OF_MEMORY \| LOCERR_EXPORT_NO_DATA \| LOCERR_SYNC_INVALID_OFFSET \| LOCERR_SEARCH_TIMEOUT \| LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL \| LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW \| LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT \| LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED \| LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED \| LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED \| LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED \| LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED \| LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED \| LOCERR_SMART_LOAD_TABLE_NOT_FOUND \| LOCERR_SMART_LOAD_TABLE_DUPLICATED \| LOCERR_VARIABLE_NO_NAME \| LOCERR_VARIABLE_DUPLICATE_NAME \| LOCERR_VARIABLE_INCONSISTENCY \| LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY \| LOCERR_VARIABLE_CONSTRAINT_FAILED \| LOCERR_MEDIA_LIBRARY_LIST_FAILED \| LOCERR_MEDIA_LIBRARY_CONTENT_FAILED \| LOCERR_MEDIA_BUNDLING_FAILED \| LOCERR_MEDIA_UNBUNDLING_FAILED \| LOCERR_MEDIA_LIBRARY_NOT_FOUND \| LOCERR_FEATURE_DISABLED \| LOCERR_LOAD_TOO_MANY_FIELDS \| LOCERR_LOAD_TOO_MANY_TABLES \| LOCERR_JSON_RPC_INVALID_REQUEST \| LOCERR_JSON_RPC_METHOD_NOT_FOUND \| LOCERR_JSON_RPC_INVALID_PARAMETERS \| LOCERR_JSON_RPC_INTERNAL_ERROR \| LOCERR_JSON_RPC_RESPONSE_TOO_LARGE \| LOCERR_JSON_RPC_PARSE_ERROR \| LOCERR_MQ_SOCKET_CONNECT_FAILURE \| LOCERR_MQ_SOCKET_OPEN_FAILURE \| LOCERR_MQ_PROTOCOL_NO_RESPONE \| LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION \| LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED \| LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED \| LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR \| LOCERR_MQ_PROTOCOL_INVALID_STATUS \| LOCERR_EXTENGINE_GRPC_STATUS_OK \| LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED \| LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN \| LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT \| LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED \| LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND \| LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS \| LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED \| LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED \| LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION \| LOCERR_EXTENGINE_GRPC_STATUS_ABORTED \| LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE \| LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED \| LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL \| LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE \| LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS \| LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED \| LOCERR_LXW_INVALID_OBJ \| LOCERR_LXW_INVALID_FILE \| LOCERR_LXW_INVALID_SHEET \| LOCERR_LXW_INVALID_EXPORT_RANGE \| LOCERR_LXW_ERROR \| LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED \| LOCERR_LXW_ERROR_CREATING_XLSX_FILE \| LOCERR_LXW_ERROR_CREATING_TMPFILE \| LOCERR_LXW_ERROR_ZIP_FILE_OPERATION \| LOCERR_LXW_ERROR_ZIP_FILE_ADD \| LOCERR_LXW_ERROR_ZIP_CLOSE \| LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED \| LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED \| LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED \| LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND \| LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE \| LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED \| LOCERR_BDI_STATUS_OK \| LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED \| LOCERR_TRENDLINE_INVALID_DEF \| LOCERR_TRENDLINE_INVALID_MATH_ERROR \| LOCERR_CURL_UNSUPPORTED_PROTOCOL \| LOCERR_CURL_COULDNT_RESOLVE_PROXY \| LOCERR_CURL_COULDNT_CONNECT \| LOCERR_CURL_REMOTE_ACCESS_DENIED \| LOCERR_CURL_FTP_ACCEPT_FAILED \| LOCERR_CURL_FTP_ACCEPT_TIMEOUT \| LOCERR_CURL_FTP_CANT_GET_HOST \| LOCERR_CURL_PARTIAL_FILE \| LOCERR_CURL_QUOTE_ERROR \| LOCERR_CURL_WRITE_ERROR \| LOCERR_CURL_UPLOAD_FAILED \| LOCERR_CURL_OUT_OF_MEMORY \| LOCERR_CURL_OPERATION_TIMEDOUT \| LOCERR_CURL_FTP_COULDNT_USE_REST \| LOCERR_CURL_HTTP_POST_ERROR \| LOCERR_CURL_SSL_CONNECT_ERROR \| LOCERR_CURL_FILE_COULDNT_READ_FILE \| LOCERR_CURL_LDAP_CANNOT_BIND \| LOCERR_CURL_LDAP_SEARCH_FAILED \| LOCERR_CURL_TOO_MANY_REDIRECTS \| LOCERR_CURL_PEER_FAILED_VERIFICATION \| LOCERR_CURL_GOT_NOTHING \| LOCERR_CURL_SSL_ENGINE_NOTFOUND \| LOCERR_CURL_SSL_ENGINE_SETFAILED \| LOCERR_CURL_SSL_CERTPROBLEM \| LOCERR_CURL_SSL_CIPHER \| LOCERR_CURL_SSL_CACERT \| LOCERR_CURL_BAD_CONTENT_ENCODING \| LOCERR_CURL_LDAP_INVALID_URL \| LOCERR_CURL_USE_SSL_FAILED \| LOCERR_CURL_SSL_ENGINE_INITFAILED \| LOCERR_CURL_LOGIN_DENIED \| LOCERR_CURL_TFTP_NOTFOUND \| LOCERR_CURL_TFTP_ILLEGAL \| LOCERR_CURL_SSH \| LOCERR_SETEXPRESSION_TOO_LARGE \| LOCERR_RELOAD_MERGE_LOAD_ERROR \| LOCERR_WIN_FTP_DROPPED \| LOCERR_WIN_FTP_NO_PASSIVE_MODE \| LOCERR_WIN_HTTP_DOWNLEVEL_SERVER \| LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE \| LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION \| LOCERR_WIN_INTERNET_FORCE_RETRY \| LOCERR_WIN_INTERNET_CANNOT_CONNECT \| LOCERR_WIN_INTERNET_CONNECTION_ABORTED \| LOCERR_WIN_INTERNET_CONNECTION_RESET \| LOCERR_WIN_INTERNET_DISCONNECTED \| LOCERR_WIN_INTERNET_INCORRECT_FORMAT \| LOCERR_WIN_INTERNET_INVALID_CA \| LOCERR_WIN_INTERNET_INVALID_OPERATION \| LOCERR_WIN_INTERNET_INVALID_URL \| LOCERR_WIN_INTERNET_ITEM_NOT_FOUND \| LOCERR_WIN_INTERNET_LOGIN_FAILURE \| LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED \| LOCERR_WIN_INTERNET_NEED_UI \| LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID \| LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID \| LOCERR_WIN_INTERNET_SEC_CERT_ERRORS \| LOCERR_WIN_INTERNET_SEC_INVALID_CERT \| LOCERR_WIN_INTERNET_SERVER_UNREACHABLE \| LOCERR_BM_RESULT_TOO_LARGE) | |
Properties of `NxLocalizedErrorCode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_INTERNAL_ERROR` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_UNKNOWN` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_OK` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_SET` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_FOUND` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ALREADY_EXISTS` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVALID_PATH` | `object` | |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ACCESS_DENIED` | `object` | |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_OUT_OF_MEMORY` | `object` | |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_INITIALIZED` | `object` | |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVALID_PARAMETERS` | `object` | |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_EMPTY_PARAMETERS` | `object` | |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INTERNAL_ERROR` | `object` | |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_CORRUPT_DATA` | `object` | |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_MEMORY_INCONSISTENCY` | `object` | |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVISIBLE_OWNER_ABORT` | `object` | |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_PROHIBIT_VALIDATE` | `object` | |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ABORTED` | `object` | |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_CONNECTION_LOST` | `object` | |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION` | `object` | |
**Option 21:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_REST_CONNECTION_FAILURE` | `object` | |
**Option 22:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_MEMORY_LIMIT_REACHED` | `object` | |
**Option 23:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_IMPLEMENTED` | `object` | |
**Option 24:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ENGINE_TERMINATED` | `object` | |
**Option 25:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED` | `object` | |
**Option 26:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_400` | `object` | |
**Option 27:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_401` | `object` | |
**Option 28:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_402` | `object` | |
**Option 29:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_403` | `object` | |
**Option 30:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_404` | `object` | |
**Option 31:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_405` | `object` | |
**Option 32:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_406` | `object` | |
**Option 33:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_407` | `object` | |
**Option 34:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_408` | `object` | |
**Option 35:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_409` | `object` | |
**Option 36:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_410` | `object` | |
**Option 37:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_411` | `object` | |
**Option 38:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_412` | `object` | |
**Option 39:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_413` | `object` | |
**Option 40:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_414` | `object` | |
**Option 41:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_415` | `object` | |
**Option 42:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_416` | `object` | |
**Option 43:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_417` | `object` | |
**Option 44:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_422` | `object` | |
**Option 45:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_423` | `object` | |
**Option 46:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_429` | `object` | |
**Option 47:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_500` | `object` | |
**Option 48:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_501` | `object` | |
**Option 49:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_502` | `object` | |
**Option 50:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_503` | `object` | |
**Option 51:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_504` | `object` | |
**Option 52:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_505` | `object` | |
**Option 53:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_509` | `object` | |
**Option 54:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_COULD_NOT_RESOLVE_HOST` | `object` | |
**Option 55:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_EXISTS` | `object` | |
**Option 56:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_INVALID_NAME` | `object` | |
**Option 57:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_OPEN` | `object` | |
**Option 58:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_NOT_FOUND` | `object` | |
**Option 59:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_IMPORT_FAILED` | `object` | |
**Option 60:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SAVE_FAILED` | `object` | |
**Option 61:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_CREATE_FAILED` | `object` | |
**Option 62:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_INVALID` | `object` | |
**Option 63:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_CONNECT_FAILED` | `object` | |
**Option 64:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE` | `object` | |
**Option 65:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE` | `object` | |
**Option 66:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION` | `object` | |
**Option 67:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_FAILURE` | `object` | |
**Option 68:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SCRIPT_MISSING` | `object` | |
**Option 69:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_EXPORT_FAILED` | `object` | |
**Option 70:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SIZE_EXCEEDED` | `object` | |
**Option 71:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED` | `object` | |
**Option 72:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_NOT_OPEN` | `object` | |
**Option 73:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_EVENT_SOURCE_TIMEOUT` | `object` | |
**Option 74:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_ALREADY_EXISTS` | `object` | |
**Option 75:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_NOT_FOUND` | `object` | |
**Option 76:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_FAILED_TO_LOAD` | `object` | |
**Option 77:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_FAILED_TO_IMPORT` | `object` | |
**Option 78:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_NAME_IS_INVALID` | `object` | |
**Option 79:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_MISSING_CREDENTIALS` | `object` | |
**Option 80:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT` | `object` | |
**Option 81:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE` | `object` | |
**Option 82:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_ACCESS_DENIED` | `object` | |
**Option 83:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_NAME_INVALID` | `object` | |
**Option 84:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_CORRUPT` | `object` | |
**Option 85:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_NOT_FOUND` | `object` | |
**Option 86:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_FORMAT_UNSUPPORTED` | `object` | |
**Option 87:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE` | `object` | |
**Option 88:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_TABLE_NOT_FOUND` | `object` | |
**Option 89:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_ACCESS_DENIED` | `object` | |
**Option 90:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_IMPERSONATION_FAILED` | `object` | |
**Option 91:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS` | `object` | |
**Option 92:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_SESSION_CALS` | `object` | |
**Option 93:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_USAGE_CALS` | `object` | |
**Option 94:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_CALS` | `object` | |
**Option 95:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_NAMED_CALS` | `object` | |
**Option 96:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OFF_DUTY` | `object` | |
**Option 97:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_BUSY` | `object` | |
**Option 98:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_LICENSE_EXPIRED` | `object` | |
**Option 99:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_AJAX_DISABLED` | `object` | |
**Option 100:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_NO_TOKEN` | `object` | |
**Option 101:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_INVALID_OBJECT` | `object` | |
**Option 102:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_RESULT_TOO_LARGE` | `object` | |
**Option 103:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_INVALID_OBJECT_STATE` | `object` | |
**Option 104:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_MODAL_OBJECT_ERROR` | `object` | |
**Option 105:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_INVALID_DEF` | `object` | |
**Option 106:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_NOT_IN_LIB` | `object` | |
**Option 107:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_HEAP_ERROR` | `object` | |
**Option 108:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_TOO_LARGE` | `object` | |
**Option 109:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_TIMEOUT` | `object` | |
**Option 110:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_EVAL_CONDITION_FAILED` | `object` | |
**Option 111:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MIXED_LINKED_AGGREGATION` | `object` | |
**Option 112:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MISSING_LINKED` | `object` | |
**Option 113:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_INVALID_COL_SORT` | `object` | |
**Option 114:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_PAGES_TOO_LARGE` | `object` | |
**Option 115:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED` | `object` | |
**Option 116:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_VALIDATION_STATE_INVALID` | `object` | |
**Option 117:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS` | `object` | |
**Option 118:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MISSING_LINKED_FIELD` | `object` | |
**Option 119:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_NOT_CALCULATED` | `object` | |
**Option 120:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_EXTENDS_INVALID_ID` | `object` | |
**Option 121:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND` | `object` | |
**Option 122:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_LINKED_OBJECT_INVALID` | `object` | |
**Option 123:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_WRITE_FAILED` | `object` | |
**Option 124:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_READ_FAILED` | `object` | |
**Option 125:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_DELETE_FAILED` | `object` | |
**Option 126:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_NOT_FOUND` | `object` | |
**Option 127:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_UNSUPPORTED_VERSION` | `object` | |
**Option 128:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY` | `object` | |
**Option 129:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_CANCELLED` | `object` | |
**Option 130:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED` | `object` | |
**Option 131:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_DISK_FULL` | `object` | |
**Option 132:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP` | `object` | |
**Option 133:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MOVE_FAILED` | `object` | |
**Option 134:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_OBJECT_LOCKED` | `object` | |
**Option 135:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING` | `object` | |
**Option 136:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS` | `object` | |
**Option 137:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS` | `object` | |
**Option 138:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED` | `object` | |
**Option 139:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_IN_PROGRESS` | `object` | |
**Option 140:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_TABLE_X_NOT_FOUND` | `object` | |
**Option 141:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_UNKNOWN_STATEMENT` | `object` | |
**Option 142:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN` | `object` | |
**Option 143:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN` | `object` | |
**Option 144:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 145:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 146:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 147:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 148:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 149:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 150:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 151:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 152:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_FIELD_X_NOT_FOUND` | `object` | |
**Option 153:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND` | `object` | |
**Option 154:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND` | `object` | |
**Option 155:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NAME_ALREADY_TAKEN` | `object` | |
**Option 156:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF` | `object` | |
**Option 157:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF` | `object` | |
**Option 158:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED` | `object` | |
**Option 159:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OPEN_FILE_ERROR` | `object` | |
**Option 160:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_AUTO_GENERATE_COUNT` | `object` | |
**Option 161:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB` | `object` | |
**Option 162:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR` | `object` | |
**Option 163:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND` | `object` | |
**Option 164:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID` | `object` | |
**Option 165:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE` | `object` | |
**Option 166:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE` | `object` | |
**Option 167:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS` | `object` | |
**Option 168:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS` | `object` | |
**Option 169:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NO_OPEN_DATABASE` | `object` | |
**Option 170:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY` | `object` | |
**Option 171:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE` | `object` | |
**Option 172:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ODBC_CONNECT_FAILED` | `object` | |
**Option 173:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OLEDB_CONNECT_FAILED` | `object` | |
**Option 174:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CUSTOM_CONNECT_FAILED` | `object` | |
**Option 175:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ODBC_READ_FAILED` | `object` | |
**Option 176:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OLEDB_READ_FAILED` | `object` | |
**Option 177:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CUSTOM_READ_FAILED` | `object` | |
**Option 178:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_BINARY_LOAD_PROHIBITED` | `object` | |
**Option 179:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_START_FAILED` | `object` | |
**Option 180:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING` | `object` | |
**Option 181:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_REPLY_ERROR` | `object` | |
**Option 182:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR` | `object` | |
**Option 183:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR` | `object` | |
**Option 184:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS` | `object` | |
**Option 185:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE` | `object` | |
**Option 186:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD` | `object` | |
**Option 187:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT` | `object` | |
**Option 188:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXIT_ERROR` | `object` | |
**Option 189:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_NEW_VERSION_AVAILABLE` | `object` | |
**Option 190:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_VERSION_EXPIRED` | `object` | |
**Option 191:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_SECTION_ACCESS_DETECTED` | `object` | |
**Option 192:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_APP_DELETION_FAILED` | `object` | |
**Option 193:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_AUTHENTICATION_FAILURE` | `object` | |
**Option 194:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXPORT_OUT_OF_MEMORY` | `object` | |
**Option 195:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXPORT_NO_DATA` | `object` | |
**Option 196:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SYNC_INVALID_OFFSET` | `object` | |
**Option 197:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SEARCH_TIMEOUT` | `object` | |
**Option 198:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL` | `object` | |
**Option 199:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW` | `object` | |
**Option 200:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT` | `object` | |
**Option 201:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED` | `object` | |
**Option 202:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED` | `object` | |
**Option 203:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED` | `object` | |
**Option 204:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED` | `object` | |
**Option 205:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED` | `object` | |
**Option 206:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED` | `object` | |
**Option 207:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SMART_LOAD_TABLE_NOT_FOUND` | `object` | |
**Option 208:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SMART_LOAD_TABLE_DUPLICATED` | `object` | |
**Option 209:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_NO_NAME` | `object` | |
**Option 210:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_DUPLICATE_NAME` | `object` | |
**Option 211:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_INCONSISTENCY` | `object` | |
**Option 212:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY` | `object` | |
**Option 213:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_CONSTRAINT_FAILED` | `object` | |
**Option 214:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_LIST_FAILED` | `object` | |
**Option 215:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_CONTENT_FAILED` | `object` | |
**Option 216:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_BUNDLING_FAILED` | `object` | |
**Option 217:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_UNBUNDLING_FAILED` | `object` | |
**Option 218:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_NOT_FOUND` | `object` | |
**Option 219:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FEATURE_DISABLED` | `object` | |
**Option 220:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LOAD_TOO_MANY_FIELDS` | `object` | |
**Option 221:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LOAD_TOO_MANY_TABLES` | `object` | |
**Option 222:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INVALID_REQUEST` | `object` | |
**Option 223:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_METHOD_NOT_FOUND` | `object` | |
**Option 224:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INVALID_PARAMETERS` | `object` | |
**Option 225:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INTERNAL_ERROR` | `object` | |
**Option 226:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_RESPONSE_TOO_LARGE` | `object` | |
**Option 227:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_PARSE_ERROR` | `object` | |
**Option 228:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_SOCKET_CONNECT_FAILURE` | `object` | |
**Option 229:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_SOCKET_OPEN_FAILURE` | `object` | |
**Option 230:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_NO_RESPONE` | `object` | |
**Option 231:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION` | `object` | |
**Option 232:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED` | `object` | |
**Option 233:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED` | `object` | |
**Option 234:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR` | `object` | |
**Option 235:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_INVALID_STATUS` | `object` | |
**Option 236:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_OK` | `object` | |
**Option 237:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED` | `object` | |
**Option 238:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN` | `object` | |
**Option 239:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT` | `object` | |
**Option 240:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED` | `object` | |
**Option 241:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND` | `object` | |
**Option 242:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS` | `object` | |
**Option 243:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED` | `object` | |
**Option 244:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED` | `object` | |
**Option 245:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION` | `object` | |
**Option 246:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_ABORTED` | `object` | |
**Option 247:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE` | `object` | |
**Option 248:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED` | `object` | |
**Option 249:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL` | `object` | |
**Option 250:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE` | `object` | |
**Option 251:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS` | `object` | |
**Option 252:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED` | `object` | |
**Option 253:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_OBJ` | `object` | |
**Option 254:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_FILE` | `object` | |
**Option 255:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_SHEET` | `object` | |
**Option 256:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_EXPORT_RANGE` | `object` | |
**Option 257:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR` | `object` | |
**Option 258:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED` | `object` | |
**Option 259:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_CREATING_XLSX_FILE` | `object` | |
**Option 260:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_CREATING_TMPFILE` | `object` | |
**Option 261:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_FILE_OPERATION` | `object` | |
**Option 262:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_FILE_ADD` | `object` | |
**Option 263:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_CLOSE` | `object` | |
**Option 264:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED` | `object` | |
**Option 265:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED` | `object` | |
**Option 266:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED` | `object` | |
**Option 267:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND` | `object` | |
**Option 268:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE` | `object` | |
**Option 269:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED` | `object` | |
**Option 270:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BDI_STATUS_OK` | `object` | |
**Option 271:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED` | `object` | |
**Option 272:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_TRENDLINE_INVALID_DEF` | `object` | |
**Option 273:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_TRENDLINE_INVALID_MATH_ERROR` | `object` | |
**Option 274:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_UNSUPPORTED_PROTOCOL` | `object` | |
**Option 275:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_COULDNT_RESOLVE_PROXY` | `object` | |
**Option 276:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_COULDNT_CONNECT` | `object` | |
**Option 277:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_REMOTE_ACCESS_DENIED` | `object` | |
**Option 278:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_ACCEPT_FAILED` | `object` | |
**Option 279:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_ACCEPT_TIMEOUT` | `object` | |
**Option 280:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_CANT_GET_HOST` | `object` | |
**Option 281:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_PARTIAL_FILE` | `object` | |
**Option 282:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_QUOTE_ERROR` | `object` | |
**Option 283:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_WRITE_ERROR` | `object` | |
**Option 284:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_UPLOAD_FAILED` | `object` | |
**Option 285:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_OUT_OF_MEMORY` | `object` | |
**Option 286:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_OPERATION_TIMEDOUT` | `object` | |
**Option 287:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_COULDNT_USE_REST` | `object` | |
**Option 288:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_HTTP_POST_ERROR` | `object` | |
**Option 289:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CONNECT_ERROR` | `object` | |
**Option 290:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FILE_COULDNT_READ_FILE` | `object` | |
**Option 291:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_CANNOT_BIND` | `object` | |
**Option 292:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_SEARCH_FAILED` | `object` | |
**Option 293:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TOO_MANY_REDIRECTS` | `object` | |
**Option 294:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_PEER_FAILED_VERIFICATION` | `object` | |
**Option 295:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_GOT_NOTHING` | `object` | |
**Option 296:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_NOTFOUND` | `object` | |
**Option 297:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_SETFAILED` | `object` | |
**Option 298:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CERTPROBLEM` | `object` | |
**Option 299:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CIPHER` | `object` | |
**Option 300:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CACERT` | `object` | |
**Option 301:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_BAD_CONTENT_ENCODING` | `object` | |
**Option 302:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_INVALID_URL` | `object` | |
**Option 303:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_USE_SSL_FAILED` | `object` | |
**Option 304:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_INITFAILED` | `object` | |
**Option 305:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LOGIN_DENIED` | `object` | |
**Option 306:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TFTP_NOTFOUND` | `object` | |
**Option 307:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TFTP_ILLEGAL` | `object` | |
**Option 308:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSH` | `object` | |
**Option 309:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SETEXPRESSION_TOO_LARGE` | `object` | |
**Option 310:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MERGE_LOAD_ERROR` | `object` | |
**Option 311:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_FTP_DROPPED` | `object` | |
**Option 312:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_FTP_NO_PASSIVE_MODE` | `object` | |
**Option 313:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_DOWNLEVEL_SERVER` | `object` | |
**Option 314:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE` | `object` | |
**Option 315:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION` | `object` | |
**Option 316:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_FORCE_RETRY` | `object` | |
**Option 317:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CANNOT_CONNECT` | `object` | |
**Option 318:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CONNECTION_ABORTED` | `object` | |
**Option 319:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CONNECTION_RESET` | `object` | |
**Option 320:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_DISCONNECTED` | `object` | |
**Option 321:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INCORRECT_FORMAT` | `object` | |
**Option 322:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_CA` | `object` | |
**Option 323:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_OPERATION` | `object` | |
**Option 324:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_URL` | `object` | |
**Option 325:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_ITEM_NOT_FOUND` | `object` | |
**Option 326:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_LOGIN_FAILURE` | `object` | |
**Option 327:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED` | `object` | |
**Option 328:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_NEED_UI` | `object` | |
**Option 329:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID` | `object` | |
**Option 330:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID` | `object` | |
**Option 331:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_ERRORS` | `object` | |
**Option 332:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_INVALID_CERT` | `object` | |
**Option 333:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SERVER_UNREACHABLE` | `object` | |
**Option 334:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BM_RESULT_TOO_LARGE` | `object` | |
---
### NxLocalizedWarningCode
| Name | Type | Description |
| --- | --- | --- |
| `NxLocalizedWarningCode` | oneOf(LOCWARN_PERSONAL_RELOAD_REQUIRED \| LOCWARN_PERSONAL_VERSION_EXPIRES_SOON \| LOCWARN_EXPORT_DATA_TRUNCATED \| LOCWARN_COULD_NOT_OPEN_ALL_OBJECTS \| LOCWARN_SEARCH_INVALID_SEARCHFIELD_DETECTED) | |
Properties of `NxLocalizedWarningCode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCWARN_PERSONAL_RELOAD_REQUIRED` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCWARN_PERSONAL_VERSION_EXPIRES_SOON` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCWARN_EXPORT_DATA_TRUNCATED` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCWARN_COULD_NOT_OPEN_ALL_OBJECTS` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCWARN_SEARCH_INVALID_SEARCHFIELD_DETECTED` | `object` | |
---
### NxMatchingFieldInfo
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qTags` | `array of string` | List of tags. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxMatchingFieldMode
| Name | Type | Description |
| --- | --- | --- |
| `NxMatchingFieldMode` | oneOf(MATCHINGFIELDMODE_MATCH_ALL \| MATCHINGFIELDMODE_MATCH_ONE) | |
Properties of `NxMatchingFieldMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `MATCHINGFIELDMODE_MATCH_ALL` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `MATCHINGFIELDMODE_MATCH_ONE` | `object` | |
---
### NxMeasure
Either **qDef** or **qLibraryId** must be set, but not both. If both are set, the library measure's qDef and qLabel will be used.
If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.
A measure that is set in the library can be used by many objects.
expressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure.
Attribute expressions do not affect the layout of an object. The sorting order is unchanged.
| Name | Type | Description |
| --- | --- | --- |
| `qLibraryId` | `string` | Refers to a measure stored in the library. |
| `qDef` | [NxInlineMeasureDef](#nxinlinemeasuredef) | |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qAttributeDimensions` | `array` of [NxAttrDimDef](#nxattrdimdef) | List of attribute dimensions. |
| `qCalcCond` | [ValueExpr](#valueexpr) | |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
| `qTrendLines` | `array` of [NxTrendlineDef](#nxtrendlinedef) | Specifies trendlines for this measure. |
| `qMiniChartDef` | [NxMiniChartDef](#nxminichartdef) | |
Properties of `qDef`
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | Name of the measure. An empty string is returned as a default value. This parameter is optional. |
| `qDescription` | `string` | Description of the measure. An empty string is returned as a default value. This parameter is optional. |
| `qTags` | `array of string` | Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qDef` | `string` | Definition of the expression in the measure. Example: _Sum (OrderTotal)_ This parameter is mandatory. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qRelative` | `boolean` | If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional. |
| `qBrutalSum` | `boolean` | If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to **Expression Total** . |
| `qAggrFunc` | `string` | 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. |
| `qAccumulate` | `integer` | * 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the _qAccumulate_ value Default value is 0. This parameter is optional. |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qActiveExpression` | `integer` | Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional. |
| `qExpressions` | `array of string` | Array of expressions. This parameter is used in case of cyclic measures ( _qGrouping_ is C). List of the expressions in the cyclic group. |
| `qLabelExpression` | `string` | Label expression. This parameter is optional. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSortBy`
| Name | Type | Description |
| --- | --- | --- |
| `qSortByState` | `integer` | Sorts the field values according to their logical state (selected, optional, alternative or excluded). |
| `qSortByFrequency` | `integer` | Sorts the field values by frequency (number of occurrences in the field). |
| `qSortByNumeric` | `integer` | Sorts the field values by numeric value. |
| `qSortByAscii` | `integer` | Sorts the field by alphabetical order. |
| `qSortByLoadOrder` | `integer` | Sorts the field values by the initial load order. |
| `qSortByExpression` | `integer` | Sorts the field by expression. |
| `qExpression` | [ValueExpr](#valueexpr) | |
| `qSortByGreyness` | `integer` | |
Properties of `qExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qAttributeExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprDef` | [NxAttrExprDef](#nxattrexprdef) | |
Properties of `NxAttrExprDef`
| Name | Type | Description |
| --- | --- | --- |
| `qExpression` | `string` | Definition of the attribute expression. Example: _"Max(OrderID)"_ |
| `qLibraryId` | `string` | Definition of the attribute expression stored in the library. Example: _"MyGenericMeasure"_ |
| `qAttribute` | `boolean` | If set to true, this measure will not affect the number of rows in the cube. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qLabel` | `string` | Label of the attribute expression. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qAttributeDimensions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrDimDef` | [NxAttrDimDef](#nxattrdimdef) | Layout for _NxAttrDimDef_. |
Properties of `NxAttrDimDef`
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | `string` | Expression or field name. |
| `qLibraryId` | `string` | LibraryId for dimension. |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qAttribute` | `boolean` | If set to true, this attribute will not affect the number of rows in the cube. |
Properties of `qSortBy`
_Properties truncated due to depth limit._
Properties of `qCalcCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qCalcCondition`
| Name | Type | Description |
| --- | --- | --- |
| `qCond` | [ValueExpr](#valueexpr) | |
| `qMsg` | [StringExpr](#stringexpr) | |
Properties of `qCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qMsg`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qTrendLines`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTrendlineDef` | [NxTrendlineDef](#nxtrendlinedef) | Trendline input definition |
Properties of `NxTrendlineDef`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(AVERAGE \| LINEAR \| POLYNOMIAL2 \| POLYNOMIAL3 \| POLYNOMIAL4 \| EXPONENTIAL \| POWER \| LOG) | |
| `qXColIx` | `integer` | The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure |
| `qCalcR2` | `boolean` | Set to true to calulatate the R2 score |
| `qContinuousXAxis` | oneOf(Never \| Possible \| Time) | |
| `qMultiDimMode` | oneOf(Multi \| Sum) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
Properties of `qContinuousXAxis`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qMultiDimMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
Properties of `qMiniChartDef`
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | `string` | Expression or field name. |
| `qLibraryId` | `string` | LibraryId for dimension. |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qOtherTotalSpec` | [OtherTotalSpecProp](#othertotalspecprop) | |
| `qMaxNumberPoints` | `integer` | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qNullSuppression` | `boolean` | If set to true, no null values are returned. |
Properties of `qSortBy`
| Name | Type | Description |
| --- | --- | --- |
| `qSortByState` | `integer` | Sorts the field values according to their logical state (selected, optional, alternative or excluded). |
| `qSortByFrequency` | `integer` | Sorts the field values by frequency (number of occurrences in the field). |
| `qSortByNumeric` | `integer` | Sorts the field values by numeric value. |
| `qSortByAscii` | `integer` | Sorts the field by alphabetical order. |
| `qSortByLoadOrder` | `integer` | Sorts the field values by the initial load order. |
| `qSortByExpression` | `integer` | Sorts the field by expression. |
| `qExpression` | [ValueExpr](#valueexpr) | |
| `qSortByGreyness` | `integer` | |
Properties of `qExpression`
_Properties truncated due to depth limit._
Properties of `qOtherTotalSpec`
| Name | Type | Description |
| --- | --- | --- |
| `qOtherMode` | oneOf(OTHER_OFF \| OTHER_COUNTED \| OTHER_ABS_LIMITED \| OTHER_ABS_ACC_TARGET \| OTHER_REL_LIMITED \| OTHER_REL_ACC_TARGET) | |
| `qOtherCounted` | [ValueExpr](#valueexpr) | |
| `qOtherLimit` | [ValueExpr](#valueexpr) | |
| `qOtherLimitMode` | oneOf(OTHER_GE_LIMIT \| OTHER_LE_LIMIT \| OTHER_GT_LIMIT \| OTHER_LT_LIMIT) | |
| `qSuppressOther` | `boolean` | If set to true, the group _Others_ is not displayed as a dimension value. The default value is false. |
| `qForceBadValueKeeping` | `boolean` | This parameter is used when _qOtherMode_ is set to: * OTHER_ABS_LIMITED * OTHER_REL_LIMITED * OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true. |
| `qApplyEvenWhenPossiblyWrongResult` | `boolean` | Set this parameter to true to allow the calculation of _Others_ even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true. |
| `qGlobalOtherGrouping` | `boolean` | This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false. |
| `qOtherCollapseInnerDimensions` | `boolean` | If set to true, it collapses the inner dimensions (if any) in the group _Others_ . The default value is false. |
| `qOtherSortMode` | oneOf(OTHER_SORT_DEFAULT \| OTHER_SORT_DESCENDING \| OTHER_SORT_ASCENDING) | |
| `qTotalMode` | oneOf(TOTAL_OFF \| TOTAL_EXPR) | |
| `qReferencedExpression` | [StringExpr](#stringexpr) | |
Properties of `qOtherMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
Properties of `qOtherCounted`
_Properties truncated due to depth limit._
Properties of `qOtherLimit`
_Properties truncated due to depth limit._
Properties of `qOtherLimitMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
Properties of `qOtherSortMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qTotalMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
Properties of `qReferencedExpression`
_Properties truncated due to depth limit._
Properties of `qAttributeExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprDef` | [NxAttrExprDef](#nxattrexprdef) | |
Properties of `NxAttrExprDef`
_Properties truncated due to depth limit._
---
### NxMeasureInfo
Layout for _NxInlineMeasureDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the measure. If the label is not defined then the measure name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qMin` | `number` | Lowest value in the range. |
| `qMax` | `number` | Highest value in the range. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | List of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | List of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qTrendLines` | `array` of [NxTrendline](#nxtrendline) | Calculated trendlines |
| `qMiniChart` | [NxMiniChart](#nxminichart) | |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_SORT_INDICATE_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_SORT_INDICATE_ASC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_SORT_INDICATE_DESC |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
Properties of `qAttrExprInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprInfo` | [NxAttrExprInfo](#nxattrexprinfo) | Layout for _NxAttrExprDef_. |
Properties of `NxAttrExprInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qFallbackTitle` | `string` | |
| `qMinText` | `string` | String version of the minimum Value. |
| `qMaxText` | `string` | String version of the maximum Value. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrDimInfo` | [NxAttrDimInfo](#nxattrdiminfo) | Layout for _NxAttrDimDef_. |
Properties of `NxAttrDimInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qCardinal` | `integer` | Cardinality of the attribute expression. |
| `qSize` | [Size](#size) | |
| `qFallbackTitle` | `string` | The title for the attribute dimension. |
| `qLocked` | `boolean` | The Locked value of the dimension. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
Properties of `qSize`
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qTrendLines`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTrendline` | [NxTrendline](#nxtrendline) | Information about the calculated trendline. |
Properties of `NxTrendline`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(AVERAGE \| LINEAR \| POLYNOMIAL2 \| POLYNOMIAL3 \| POLYNOMIAL4 \| EXPONENTIAL \| POWER \| LOG) | |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qCoeff` | `array of number` | Coefficent c0..cN depending on the trendline type. |
| `qR2` | `number` | R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation. |
| `qExpression` | `string` | Trendline expression |
| `qElemNo` | `integer` | Inner Dim elem no |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qCoeff`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMiniChart`
| Name | Type | Description |
| --- | --- | --- |
| `qYMin` | `number` | |
| `qYMax` | `number` | |
| `qXMin` | `number` | |
| `qXMax` | `number` | |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | List of attribute expressions. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
Properties of `qAttrExprInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprInfo` | [NxAttrExprInfo](#nxattrexprinfo) | Layout for _NxAttrExprDef_. |
Properties of `NxAttrExprInfo`
_Properties truncated due to depth limit._
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
---
### NxMeta
Layout for _NxMetaDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
---
### NxMetaDef
Used to collect meta data.
**Properties**
Semantic type with an empty structure.
---
### NxMiniChart
| Name | Type | Description |
| --- | --- | --- |
| `qYMin` | `number` | |
| `qYMax` | `number` | |
| `qXMin` | `number` | |
| `qXMax` | `number` | |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | List of attribute expressions. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
Properties of `qAttrExprInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprInfo` | [NxAttrExprInfo](#nxattrexprinfo) | Layout for _NxAttrExprDef_. |
Properties of `NxAttrExprInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qFallbackTitle` | `string` | |
| `qMinText` | `string` | String version of the minimum Value. |
| `qMaxText` | `string` | String version of the maximum Value. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
---
### NxMiniChartCell
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qNum` | `number` | A value. This parameter is optional. |
| `qElemNumber` | `integer` | Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values: * -1: the cell is a _Total_ cell. It shows a total. * -2: the cell is a _Null_ cell. * -3: the cell belongs to the group _Others_ . * -4: the cell is empty. Applies to pivot tables. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
Properties of `qAttrExps`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleValue](#nxsimplevalue) | List of attribute expressions values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleValue` | [NxSimpleValue](#nxsimplevalue) | |
Properties of `NxSimpleValue`
_Properties truncated due to depth limit._
---
### NxMiniChartData
| Name | Type | Description |
| --- | --- | --- |
| `qMatrix` | `array` of [NxMiniChartRows](#nxminichartrows) | Array of data. |
| `qMin` | `number` | |
| `qMax` | `number` | |
| `qError` | [NxValidationError](#nxvalidationerror) | |
Properties of `qMatrix`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMiniChartRows` | [NxMiniChartRows](#nxminichartrows) | |
Properties of `NxMiniChartRows`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMiniChartCell` | [NxMiniChartCell](#nxminichartcell) | |
Properties of `NxMiniChartCell`
_Properties truncated due to depth limit._
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
---
### NxMiniChartDef
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | `string` | Expression or field name. |
| `qLibraryId` | `string` | LibraryId for dimension. |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qOtherTotalSpec` | [OtherTotalSpecProp](#othertotalspecprop) | |
| `qMaxNumberPoints` | `integer` | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qNullSuppression` | `boolean` | If set to true, no null values are returned. |
Properties of `qSortBy`
| Name | Type | Description |
| --- | --- | --- |
| `qSortByState` | `integer` | Sorts the field values according to their logical state (selected, optional, alternative or excluded). |
| `qSortByFrequency` | `integer` | Sorts the field values by frequency (number of occurrences in the field). |
| `qSortByNumeric` | `integer` | Sorts the field values by numeric value. |
| `qSortByAscii` | `integer` | Sorts the field by alphabetical order. |
| `qSortByLoadOrder` | `integer` | Sorts the field values by the initial load order. |
| `qSortByExpression` | `integer` | Sorts the field by expression. |
| `qExpression` | [ValueExpr](#valueexpr) | |
| `qSortByGreyness` | `integer` | |
Properties of `qExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherTotalSpec`
| Name | Type | Description |
| --- | --- | --- |
| `qOtherMode` | oneOf(OTHER_OFF \| OTHER_COUNTED \| OTHER_ABS_LIMITED \| OTHER_ABS_ACC_TARGET \| OTHER_REL_LIMITED \| OTHER_REL_ACC_TARGET) | |
| `qOtherCounted` | [ValueExpr](#valueexpr) | |
| `qOtherLimit` | [ValueExpr](#valueexpr) | |
| `qOtherLimitMode` | oneOf(OTHER_GE_LIMIT \| OTHER_LE_LIMIT \| OTHER_GT_LIMIT \| OTHER_LT_LIMIT) | |
| `qSuppressOther` | `boolean` | If set to true, the group _Others_ is not displayed as a dimension value. The default value is false. |
| `qForceBadValueKeeping` | `boolean` | This parameter is used when _qOtherMode_ is set to: * OTHER_ABS_LIMITED * OTHER_REL_LIMITED * OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true. |
| `qApplyEvenWhenPossiblyWrongResult` | `boolean` | Set this parameter to true to allow the calculation of _Others_ even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true. |
| `qGlobalOtherGrouping` | `boolean` | This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false. |
| `qOtherCollapseInnerDimensions` | `boolean` | If set to true, it collapses the inner dimensions (if any) in the group _Others_ . The default value is false. |
| `qOtherSortMode` | oneOf(OTHER_SORT_DEFAULT \| OTHER_SORT_DESCENDING \| OTHER_SORT_ASCENDING) | |
| `qTotalMode` | oneOf(TOTAL_OFF \| TOTAL_EXPR) | |
| `qReferencedExpression` | [StringExpr](#stringexpr) | |
Properties of `qOtherMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_COUNTED` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_LIMITED` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_ACC_TARGET` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_LIMITED` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_ACC_TARGET` | `object` | |
Properties of `qOtherCounted`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherLimit`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherLimitMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GE_LIMIT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LE_LIMIT` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GT_LIMIT` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LT_LIMIT` | `object` | |
Properties of `qOtherSortMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DEFAULT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DESCENDING` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_ASCENDING` | `object` | |
Properties of `qTotalMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_EXPR` | `object` | |
Properties of `qReferencedExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qAttributeExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprDef` | [NxAttrExprDef](#nxattrexprdef) | |
Properties of `NxAttrExprDef`
| Name | Type | Description |
| --- | --- | --- |
| `qExpression` | `string` | Definition of the attribute expression. Example: _"Max(OrderID)"_ |
| `qLibraryId` | `string` | Definition of the attribute expression stored in the library. Example: _"MyGenericMeasure"_ |
| `qAttribute` | `boolean` | If set to true, this measure will not affect the number of rows in the cube. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qLabel` | `string` | Label of the attribute expression. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
Properties of `qNumFormat`
_Properties truncated due to depth limit._
---
### NxMiniChartRows
| Name | Type | Description |
| --- | --- | --- |
| `NxMiniChartRows` | `array` of [NxMiniChartCell](#nxminichartcell) | |
Properties of `NxMiniChartRows`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMiniChartCell` | [NxMiniChartCell](#nxminichartcell) | |
Properties of `NxMiniChartCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qNum` | `number` | A value. This parameter is optional. |
| `qElemNumber` | `integer` | Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values: * -1: the cell is a _Total_ cell. It shows a total. * -2: the cell is a _Null_ cell. * -3: the cell belongs to the group _Others_ . * -4: the cell is empty. Applies to pivot tables. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
Properties of `qAttrExps`
_Properties truncated due to depth limit._
---
### NxMultiRangeSelectInfo
| Name | Type | Description |
| --- | --- | --- |
| `qRanges` | `array` of [NxRangeSelectInfo](#nxrangeselectinfo) | |
| `qColumnsToSelect` | `array of integer` | |
Properties of `qRanges`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxRangeSelectInfo` | [NxRangeSelectInfo](#nxrangeselectinfo) | |
Properties of `NxRangeSelectInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qRange` | [Range](#range) | |
| `qMeasureIx` | `integer` | Number of the measure to select. Numbering starts from 0. |
Properties of `qRange`
_Properties truncated due to depth limit._
Properties of `qColumnsToSelect`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### NxPage
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
---
### NxPageTreeLevel
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order. |
| `qDepth` | `integer` | Number of dimensions to include in the tree. |
---
### NxPageTreeNode
Defines an area of the tree to be fetched.
| Name | Type | Description |
| --- | --- | --- |
| `qArea` | [Rect](#rect) | |
| `qAllValues` | `boolean` | When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not. |
Properties of `qArea`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
---
### NxPatch
| Name | Type | Description |
| --- | --- | --- |
| `qOp` | oneOf(add \| remove \| replace) | |
| `qPath` | `string` | Path to the property to add, remove or replace. |
| `qValue` | `string` | This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", "\"New title\"" |
Properties of `qOp`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `add` | `object` | Add |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `remove` | `object` | Remove |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `replace` | `object` | Replace |
---
### NxPatchOperationType
| Name | Type | Description |
| --- | --- | --- |
| `NxPatchOperationType` | oneOf(add \| remove \| replace) | |
Properties of `NxPatchOperationType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `add` | `object` | Add |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `remove` | `object` | Remove |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `replace` | `object` | Replace |
---
### NxPatches
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qPatches` | `array` of [NxPatch](#nxpatch) | Array with patches. |
| `qChildren` | `array` of [NxPatches](#nxpatches) | Array with child objects and their patches. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
Properties of `qPatches`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPatch` | [NxPatch](#nxpatch) | |
Properties of `NxPatch`
| Name | Type | Description |
| --- | --- | --- |
| `qOp` | oneOf(add \| remove \| replace) | |
| `qPath` | `string` | Path to the property to add, remove or replace. |
| `qValue` | `string` | This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", "\"New title\"" |
Properties of `qOp`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qChildren`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPatches` | [NxPatches](#nxpatches) | |
Properties of `NxPatches`
| Name | Type | Description |
| --- | --- | --- |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qPatches` | `array` of [NxPatch](#nxpatch) | Array with patches. |
| `qChildren` | `array` of [NxPatches](#nxpatches) | Array with child objects and their patches. |
Properties of `qInfo`
_Properties truncated due to depth limit._
Properties of `qPatches`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qChildren`
**Array items:**
_Properties truncated due to depth limit._
---
### NxPivotDimensionCell
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qElemNo` | `integer` | Rank number of the value. If set to -1, it means that the value is not an element number. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qUp` | `integer` | Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . |
| `qDown` | `integer` | Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . |
| `qSubNodes` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about sub nodes (or sub cells). The array is empty _[ ]_ when there is no sub nodes. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | NX_DIM_CELL_VALUE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `E` | `object` | NX_DIM_CELL_EMPTY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIM_CELL_NORMAL |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIM_CELL_TOTAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `O` | `object` | NX_DIM_CELL_OTHER |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_DIM_CELL_AGGR |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | NX_DIM_CELL_PSEUDO |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | NX_DIM_CELL_ROOT |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | NX_DIM_CELL_NULL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `G` | `object` | NX_DIM_CELL_GENERATED |
Properties of `qSubNodes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPivotDimensionCell` | [NxPivotDimensionCell](#nxpivotdimensioncell) | |
Properties of `NxPivotDimensionCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qElemNo` | `integer` | Rank number of the value. If set to -1, it means that the value is not an element number. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qUp` | `integer` | Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . |
| `qDown` | `integer` | Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . |
| `qSubNodes` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about sub nodes (or sub cells). The array is empty _[ ]_ when there is no sub nodes. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qSubNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qAttrExps`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleValue](#nxsimplevalue) | List of attribute expressions values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleValue` | [NxSimpleValue](#nxsimplevalue) | |
Properties of `NxSimpleValue`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleDimValue](#nxsimpledimvalue) | List of values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleDimValue` | [NxSimpleDimValue](#nxsimpledimvalue) | |
Properties of `NxSimpleDimValue`
_Properties truncated due to depth limit._
---
### NxPivotPage
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about the left dimension values of a pivot table. |
| `qTop` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given. |
| `qData` | `array` of [ArrayOfNxValuePoint](#arrayofnxvaluepoint) | Array of data. |
| `qArea` | [Rect](#rect) | |
Properties of `qLeft`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPivotDimensionCell` | [NxPivotDimensionCell](#nxpivotdimensioncell) | |
Properties of `NxPivotDimensionCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qElemNo` | `integer` | Rank number of the value. If set to -1, it means that the value is not an element number. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qUp` | `integer` | Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . |
| `qDown` | `integer` | Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . |
| `qSubNodes` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about sub nodes (or sub cells). The array is empty _[ ]_ when there is no sub nodes. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qSubNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qTop`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPivotDimensionCell` | [NxPivotDimensionCell](#nxpivotdimensioncell) | |
Properties of `NxPivotDimensionCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qElemNo` | `integer` | Rank number of the value. If set to -1, it means that the value is not an element number. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qUp` | `integer` | Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . |
| `qDown` | `integer` | Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ . |
| `qSubNodes` | `array` of [NxPivotDimensionCell](#nxpivotdimensioncell) | Information about sub nodes (or sub cells). The array is empty _[ ]_ when there is no sub nodes. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qSubNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ArrayOfNxValuePoint` | [ArrayOfNxValuePoint](#arrayofnxvaluepoint) | |
Properties of `ArrayOfNxValuePoint`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPivotValuePoint` | [NxPivotValuePoint](#nxpivotvaluepoint) | |
Properties of `NxPivotValuePoint`
_Properties truncated due to depth limit._
Properties of `qArea`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
---
### NxPivotValuePoint
| Name | Type | Description |
| --- | --- | --- |
| `qLabel` | `string` | Label of the cell. This parameter is optional. |
| `qText` | `string` | Some text related to the cell. |
| `qNum` | `number` | Value of the cell. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | NX_DIM_CELL_VALUE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `E` | `object` | NX_DIM_CELL_EMPTY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIM_CELL_NORMAL |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIM_CELL_TOTAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `O` | `object` | NX_DIM_CELL_OTHER |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_DIM_CELL_AGGR |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | NX_DIM_CELL_PSEUDO |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | NX_DIM_CELL_ROOT |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | NX_DIM_CELL_NULL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `G` | `object` | NX_DIM_CELL_GENERATED |
Properties of `qAttrExps`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleValue](#nxsimplevalue) | List of attribute expressions values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleValue` | [NxSimpleValue](#nxsimplevalue) | |
Properties of `NxSimpleValue`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleDimValue](#nxsimpledimvalue) | List of values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleDimValue` | [NxSimpleDimValue](#nxsimpledimvalue) | |
Properties of `NxSimpleDimValue`
_Properties truncated due to depth limit._
---
### NxRange
| Name | Type | Description |
| --- | --- | --- |
| `qFrom` | `integer` | Position in the expression of the first character of the field name. |
| `qCount` | `integer` | Number of characters in the field name. |
---
### NxRangeSelectInfo
| Name | Type | Description |
| --- | --- | --- |
| `qRange` | [Range](#range) | |
| `qMeasureIx` | `integer` | Number of the measure to select. Numbering starts from 0. |
Properties of `qRange`
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Lowest value in the range |
| `qMax` | `number` | Highest value in the range |
| `qMinInclEq` | `boolean` | If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 1 is included in the range of selections. |
| `qMaxInclEq` | `boolean` | If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 10 is included in the range of selections. |
---
### NxSelectionCell
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(D \| T \| L) | |
| `qCol` | `integer` | Column index to select. Indexing starts from 0. If the cell's type is: * D, the index is based on the data matrix. * T, the index is based on the data matrix. * L, the index is based on the left dimensions indexes. |
| `qRow` | `integer` | Row index to select. Indexing starts from 0. If the cell's type is: * D, the index is based on the data matrix. * T, the index is based on the top dimensions indexes. * L, the index is based on the data matrix. |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_CELL_DATA |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_CELL_TOP |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `L` | `object` | NX_CELL_LEFT |
---
### NxSelectionCellType
| Name | Type | Description |
| --- | --- | --- |
| `NxSelectionCellType` | oneOf(D \| T \| L) | |
Properties of `NxSelectionCellType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_CELL_DATA |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_CELL_TOP |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `L` | `object` | NX_CELL_LEFT |
---
### NxSelectionInfo
| Name | Type | Description |
| --- | --- | --- |
| `qInSelections` | `boolean` | Is set to true if the visualization is in selection mode. For more information about the selection mode, see _BeginSelections Method_. |
| `qMadeSelections` | `boolean` | Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see _BeginSelections Method_. |
---
### NxSimpleDimValue
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric. |
| `qElemNo` | `integer` | Element number. |
---
### NxSimpleValue
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the attribute expression value. |
| `qNum` | `number` | Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric. |
---
### NxSortIndicatorType
| Name | Type | Description |
| --- | --- | --- |
| `NxSortIndicatorType` | oneOf(N \| A \| D) | |
Properties of `NxSortIndicatorType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_SORT_INDICATE_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_SORT_INDICATE_ASC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_SORT_INDICATE_DESC |
---
### NxStackPage
| Name | Type | Description |
| --- | --- | --- |
| `qData` | `array` of [NxStackedPivotCell](#nxstackedpivotcell) | Array of data. |
| `qArea` | [Rect](#rect) | |
Properties of `qData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxStackedPivotCell` | [NxStackedPivotCell](#nxstackedpivotcell) | |
Properties of `NxStackedPivotCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qElemNo` | `integer` | Rank number of the value. If set to -1, it means that the value is not an element number. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qMaxPos` | `number` | Total of the positive values in the current group of cells. |
| `qMinNeg` | `number` | Total of the negative values in the current group of cells. |
| `qUp` | `integer` | Number of elements that are part of the previous tail. |
| `qDown` | `integer` | Number of elements that are part of the next tail. |
| `qRow` | `integer` | Row index in the data matrix. The indexing starts from 0. |
| `qSubNodes` | `array` of [NxStackedPivotCell](#nxstackedpivotcell) | Information about sub nodes (or sub cells). The array is empty _[ ]_ when there are no sub nodes. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qSubNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qArea`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
---
### NxStackedPivotCell
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qElemNo` | `integer` | Rank number of the value. If set to -1, it means that the value is not an element number. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qMaxPos` | `number` | Total of the positive values in the current group of cells. |
| `qMinNeg` | `number` | Total of the negative values in the current group of cells. |
| `qUp` | `integer` | Number of elements that are part of the previous tail. |
| `qDown` | `integer` | Number of elements that are part of the next tail. |
| `qRow` | `integer` | Row index in the data matrix. The indexing starts from 0. |
| `qSubNodes` | `array` of [NxStackedPivotCell](#nxstackedpivotcell) | Information about sub nodes (or sub cells). The array is empty _[ ]_ when there are no sub nodes. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | NX_DIM_CELL_VALUE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `E` | `object` | NX_DIM_CELL_EMPTY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIM_CELL_NORMAL |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIM_CELL_TOTAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `O` | `object` | NX_DIM_CELL_OTHER |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_DIM_CELL_AGGR |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | NX_DIM_CELL_PSEUDO |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | NX_DIM_CELL_ROOT |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | NX_DIM_CELL_NULL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `G` | `object` | NX_DIM_CELL_GENERATED |
Properties of `qSubNodes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxStackedPivotCell` | [NxStackedPivotCell](#nxstackedpivotcell) | |
Properties of `NxStackedPivotCell`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Some text. |
| `qElemNo` | `integer` | Rank number of the value. If set to -1, it means that the value is not an element number. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qMaxPos` | `number` | Total of the positive values in the current group of cells. |
| `qMinNeg` | `number` | Total of the negative values in the current group of cells. |
| `qUp` | `integer` | Number of elements that are part of the previous tail. |
| `qDown` | `integer` | Number of elements that are part of the next tail. |
| `qRow` | `integer` | Row index in the data matrix. The indexing starts from 0. |
| `qSubNodes` | `array` of [NxStackedPivotCell](#nxstackedpivotcell) | Information about sub nodes (or sub cells). The array is empty _[ ]_ when there are no sub nodes. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qSubNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qAttrExps`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleValue](#nxsimplevalue) | List of attribute expressions values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleValue` | [NxSimpleValue](#nxsimplevalue) | |
Properties of `NxSimpleValue`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleDimValue](#nxsimpledimvalue) | List of values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleDimValue` | [NxSimpleDimValue](#nxsimpledimvalue) | |
Properties of `NxSimpleDimValue`
_Properties truncated due to depth limit._
---
### NxStateCounts
| Name | Type | Description |
| --- | --- | --- |
| `qLocked` | `integer` | Number of values in locked state. |
| `qSelected` | `integer` | Number of values in selected state. |
| `qOption` | `integer` | Number of values in optional state. |
| `qDeselected` | `integer` | Number of values in deselected state. |
| `qAlternative` | `integer` | Number of values in alternative state. |
| `qExcluded` | `integer` | Number of values in excluded state. |
| `qSelectedExcluded` | `integer` | Number of values in selected excluded state. |
| `qLockedExcluded` | `integer` | Number of values in locked excluded state. |
---
### NxStreamListEntry
This struct is deprecated (not recommended to use).
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the stream. |
| `qId` | `string` | Identifier of the stream. |
---
### NxTempBookmarkOptions
| Name | Type | Description |
| --- | --- | --- |
| `qIncludeVariables` | `boolean` | IncludeVariables If true all variables will be stored in the temporary bookmark |
| `qIncludeAllPatches` | `boolean` | IncludeAllPatches If true all patches will be stored in the temporary bookmark, if false ObjectIdsToPatch will determine what patches to include |
---
### NxTickCell
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Tick's label. |
| `qStart` | `number` | Start value. |
| `qEnd` | `number` | End value. |
---
### NxTreeDataOption
Specifies all the paging filters needed to define the tree to be fetched.
| Name | Type | Description |
| --- | --- | --- |
| `qMaxNbrOfNodes` | `integer` | Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted. |
| `qTreeNodes` | `array` of [NxPageTreeNode](#nxpagetreenode) | Defines areas of the tree to be fetched. Areas must be defined left to right. |
| `qTreeLevels` | [NxPageTreeLevel](#nxpagetreelevel) | |
Properties of `qTreeNodes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxPageTreeNode` | [NxPageTreeNode](#nxpagetreenode) | Defines an area of the tree to be fetched. |
Properties of `NxPageTreeNode`
| Name | Type | Description |
| --- | --- | --- |
| `qArea` | [Rect](#rect) | |
| `qAllValues` | `boolean` | When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not. |
Properties of `qArea`
_Properties truncated due to depth limit._
Properties of `qTreeLevels`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order. |
| `qDepth` | `integer` | Number of dimensions to include in the tree. |
---
### NxTreeDimensionDef
| Name | Type | Description |
| --- | --- | --- |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qDef` | [NxInlineDimensionDef](#nxinlinedimensiondef) | |
| `qValueExprs` | `array` of [NxMeasure](#nxmeasure) | List of measures. |
| `qNullSuppression` | `boolean` | If set to true, no null values are returned. |
| `qOtherTotalSpec` | [OtherTotalSpecProp](#othertotalspecprop) | |
| `qShowAll` | `boolean` | If set to true, all dimension values are shown. |
| `qOtherLabel` | [StringExpr](#stringexpr) | |
| `qTotalLabel` | [StringExpr](#stringexpr) | |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qAttributeDimensions` | `array` of [NxAttrDimDef](#nxattrdimdef) | List of attribute dimensions. |
Properties of `qDef`
| Name | Type | Description |
| --- | --- | --- |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qFieldDefs` | `array of string` | Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional. |
| `qFieldLabels` | `array of string` | Array of field labels. This parameter is optional. |
| `qSortCriterias` | `array` of [SortCriteria](#sortcriteria) | Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional. |
| `qNumberPresentations` | `array` of [FieldAttributes](#fieldattributes) | Defines the format of the value. This parameter is optional. |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qActiveField` | `integer` | Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( _qGrouping_ is C). |
| `qLabelExpression` | `string` | Label expression. This parameter is optional. |
| `qAlias` | `string` | Alias of the dimension. |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldLabels`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSortCriterias`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SortCriteria` | [SortCriteria](#sortcriteria) | |
Properties of `SortCriteria`
_Properties truncated due to depth limit._
Properties of `qNumberPresentations`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldAttributes` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
Properties of `FieldAttributes`
_Properties truncated due to depth limit._
Properties of `qValueExprs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMeasure` | [NxMeasure](#nxmeasure) | Either **qDef** or **qLibraryId** must be set, but not both. If both are set, the library measure's qDef and qLabel will be used.
If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.
A measure that is set in the library can be used by many objects.
expressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure. Attribute expressions do not affect the layout of an object. The sorting order is unchanged.
|
Properties of `NxMeasure`
| Name | Type | Description |
| --- | --- | --- |
| `qLibraryId` | `string` | Refers to a measure stored in the library. |
| `qDef` | [NxInlineMeasureDef](#nxinlinemeasuredef) | |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qAttributeDimensions` | `array` of [NxAttrDimDef](#nxattrdimdef) | List of attribute dimensions. |
| `qCalcCond` | [ValueExpr](#valueexpr) | |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
| `qTrendLines` | `array` of [NxTrendlineDef](#nxtrendlinedef) | Specifies trendlines for this measure. |
| `qMiniChartDef` | [NxMiniChartDef](#nxminichartdef) | |
Properties of `qDef`
_Properties truncated due to depth limit._
Properties of `qSortBy`
_Properties truncated due to depth limit._
Properties of `qAttributeExpressions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttributeDimensions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCalcCond`
_Properties truncated due to depth limit._
Properties of `qCalcCondition`
_Properties truncated due to depth limit._
Properties of `qTrendLines`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMiniChartDef`
_Properties truncated due to depth limit._
Properties of `qOtherTotalSpec`
| Name | Type | Description |
| --- | --- | --- |
| `qOtherMode` | oneOf(OTHER_OFF \| OTHER_COUNTED \| OTHER_ABS_LIMITED \| OTHER_ABS_ACC_TARGET \| OTHER_REL_LIMITED \| OTHER_REL_ACC_TARGET) | |
| `qOtherCounted` | [ValueExpr](#valueexpr) | |
| `qOtherLimit` | [ValueExpr](#valueexpr) | |
| `qOtherLimitMode` | oneOf(OTHER_GE_LIMIT \| OTHER_LE_LIMIT \| OTHER_GT_LIMIT \| OTHER_LT_LIMIT) | |
| `qSuppressOther` | `boolean` | If set to true, the group _Others_ is not displayed as a dimension value. The default value is false. |
| `qForceBadValueKeeping` | `boolean` | This parameter is used when _qOtherMode_ is set to: * OTHER_ABS_LIMITED * OTHER_REL_LIMITED * OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true. |
| `qApplyEvenWhenPossiblyWrongResult` | `boolean` | Set this parameter to true to allow the calculation of _Others_ even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true. |
| `qGlobalOtherGrouping` | `boolean` | This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false. |
| `qOtherCollapseInnerDimensions` | `boolean` | If set to true, it collapses the inner dimensions (if any) in the group _Others_ . The default value is false. |
| `qOtherSortMode` | oneOf(OTHER_SORT_DEFAULT \| OTHER_SORT_DESCENDING \| OTHER_SORT_ASCENDING) | |
| `qTotalMode` | oneOf(TOTAL_OFF \| TOTAL_EXPR) | |
| `qReferencedExpression` | [StringExpr](#stringexpr) | |
Properties of `qOtherMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_COUNTED` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_LIMITED` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_ACC_TARGET` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_LIMITED` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_ACC_TARGET` | `object` | |
Properties of `qOtherCounted`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherLimit`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherLimitMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GE_LIMIT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LE_LIMIT` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GT_LIMIT` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LT_LIMIT` | `object` | |
Properties of `qOtherSortMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DEFAULT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DESCENDING` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_ASCENDING` | `object` | |
Properties of `qTotalMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_EXPR` | `object` | |
Properties of `qReferencedExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qOtherLabel`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qTotalLabel`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qCalcCondition`
| Name | Type | Description |
| --- | --- | --- |
| `qCond` | [ValueExpr](#valueexpr) | |
| `qMsg` | [StringExpr](#stringexpr) | |
Properties of `qCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qMsg`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qAttributeExpressions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprDef` | [NxAttrExprDef](#nxattrexprdef) | |
Properties of `NxAttrExprDef`
| Name | Type | Description |
| --- | --- | --- |
| `qExpression` | `string` | Definition of the attribute expression. Example: _"Max(OrderID)"_ |
| `qLibraryId` | `string` | Definition of the attribute expression stored in the library. Example: _"MyGenericMeasure"_ |
| `qAttribute` | `boolean` | If set to true, this measure will not affect the number of rows in the cube. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qLabel` | `string` | Label of the attribute expression. |
| `qLabelExpression` | `string` | Optional expression used for dynamic label. |
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qAttributeDimensions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrDimDef` | [NxAttrDimDef](#nxattrdimdef) | Layout for _NxAttrDimDef_. |
Properties of `NxAttrDimDef`
| Name | Type | Description |
| --- | --- | --- |
| `qDef` | `string` | Expression or field name. |
| `qLibraryId` | `string` | LibraryId for dimension. |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qAttribute` | `boolean` | If set to true, this attribute will not affect the number of rows in the cube. |
Properties of `qSortBy`
_Properties truncated due to depth limit._
---
### NxTreeDimensionInfo
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qLocked` | `boolean` | Is set to true if the field is locked. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qGroupFallbackTitles` | `array of string` | Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group). |
| `qGroupPos` | `integer` | Index of the dimension that is currently in use. _qGroupPos_ is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups. |
| `qStateCounts` | [NxStateCounts](#nxstatecounts) | |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qDimensionType` | oneOf(D \| N \| T) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's definition. |
| `qGroupFieldDefs` | `array of string` | Array of field names. |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qContinuousAxes` | `boolean` | Is continuous axis used. |
| `qIsCyclic` | `boolean` | Is a cyclic dimension used. |
| `qDerivedField` | `boolean` | Is derived field is used as a dimension. |
| `qMeasureInfo` | `array` of [NxMeasureInfo](#nxmeasureinfo) | A List of measures to be calculated on this TreeDimension. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | List of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | List of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
| `qIsOneAndOnlyOne` | `boolean` | If set to true, it means that the field always has one and only one selected value. |
| `qCardinalities` | [NxCardinalities](#nxcardinalities) | |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qEffectiveDimensionName` | `string` | The expanded and stripped dimension name used internally in engine. |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_SORT_INDICATE_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_SORT_INDICATE_ASC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_SORT_INDICATE_DESC |
Properties of `qGroupFallbackTitles`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qStateCounts`
| Name | Type | Description |
| --- | --- | --- |
| `qLocked` | `integer` | Number of values in locked state. |
| `qSelected` | `integer` | Number of values in selected state. |
| `qOption` | `integer` | Number of values in optional state. |
| `qDeselected` | `integer` | Number of values in deselected state. |
| `qAlternative` | `integer` | Number of values in alternative state. |
| `qExcluded` | `integer` | Number of values in excluded state. |
| `qSelectedExcluded` | `integer` | Number of values in selected excluded state. |
| `qLockedExcluded` | `integer` | Number of values in locked excluded state. |
Properties of `qTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
Properties of `qDimensionType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | NX_DIMENSION_TYPE_DISCRETE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIMENSION_TYPE_NUMERIC |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIMENSION_TYPE_TIME |
Properties of `qGrouping`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | GRP_NX_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `H` | `object` | GRP_NX_HIEARCHY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `C` | `object` | GRP_NX_COLLECTION |
Properties of `qNumFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
Properties of `qGroupFieldDefs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qMeasureInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMeasureInfo` | [NxMeasureInfo](#nxmeasureinfo) | Layout for _NxInlineMeasureDef_. |
Properties of `NxMeasureInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the measure. If the label is not defined then the measure name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qMin` | `number` | Lowest value in the range. |
| `qMax` | `number` | Highest value in the range. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | List of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | List of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qTrendLines` | `array` of [NxTrendline](#nxtrendline) | Calculated trendlines |
| `qMiniChart` | [NxMiniChart](#nxminichart) | |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qAttrExprInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTrendLines`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMiniChart`
_Properties truncated due to depth limit._
Properties of `qAttrExprInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrExprInfo` | [NxAttrExprInfo](#nxattrexprinfo) | Layout for _NxAttrExprDef_. |
Properties of `NxAttrExprInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qFallbackTitle` | `string` | |
| `qMinText` | `string` | String version of the minimum Value. |
| `qMaxText` | `string` | String version of the maximum Value. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxAttrDimInfo` | [NxAttrDimInfo](#nxattrdiminfo) | Layout for _NxAttrDimDef_. |
Properties of `NxAttrDimInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qCardinal` | `integer` | Cardinality of the attribute expression. |
| `qSize` | [Size](#size) | |
| `qFallbackTitle` | `string` | The title for the attribute dimension. |
| `qLocked` | `boolean` | The Locked value of the dimension. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
Properties of `qSize`
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qCardinalities`
| Name | Type | Description |
| --- | --- | --- |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qHypercubeCardinal` | `integer` | Number of distinct hypercube values. |
| `qAllValuesCardinal` | `integer` | Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure. |
---
### NxTreeMultiRangeSelectInfo
| Name | Type | Description |
| --- | --- | --- |
| `qRanges` | `array` of [NxTreeRangeSelectInfo](#nxtreerangeselectinfo) | An array of Ranges. |
Properties of `qRanges`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTreeRangeSelectInfo` | [NxTreeRangeSelectInfo](#nxtreerangeselectinfo) | |
Properties of `NxTreeRangeSelectInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qRange` | [Range](#range) | |
| `qMeasureIx` | `integer` | Number of the measure to select. Numbering starts from 0. |
| `qDimensionIx` | `integer` | Number of the dimension to select measure from. Numbering starts from 0. |
Properties of `qRange`
_Properties truncated due to depth limit._
---
### NxTreeNode
Represents a dimension in the tree.
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | The text version of the value, if available. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qElemNo` | `integer` | Element number. |
| `qGroupPos` | `integer` | The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched. |
| `qGroupSize` | `integer` | Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched. |
| `qRow` | `integer` | Row index in the data matrix. The indexing starts from 0. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qValues` | `array` of [NxTreeValue](#nxtreevalue) | The measures for this node. |
| `qNodes` | `array` of [NxTreeNode](#nxtreenode) | The children of this node in the fetched tree structure. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
| `qMaxPos` | `array of number` | Total of the positive values in the current group of cells. |
| `qMinNeg` | `array of number` | Total of the negative values in the current group of cells. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qState` | oneOf(L \| S \| O \| D \| A \| X \| XS \| XL \| NSTATES) | |
| `qTreePath` | `array of integer` | The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty. |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `V` | `object` | NX_DIM_CELL_VALUE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `E` | `object` | NX_DIM_CELL_EMPTY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `N` | `object` | NX_DIM_CELL_NORMAL |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | NX_DIM_CELL_TOTAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `O` | `object` | NX_DIM_CELL_OTHER |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | NX_DIM_CELL_AGGR |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `P` | `object` | NX_DIM_CELL_PSEUDO |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | NX_DIM_CELL_ROOT |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | NX_DIM_CELL_NULL |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `G` | `object` | NX_DIM_CELL_GENERATED |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTreeValue` | [NxTreeValue](#nxtreevalue) | Represents a measure. |
Properties of `NxTreeValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | The text version of the value, if available. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qNodes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTreeNode` | [NxTreeNode](#nxtreenode) | Represents a dimension in the tree. |
Properties of `NxTreeNode`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | The text version of the value, if available. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qElemNo` | `integer` | Element number. |
| `qGroupPos` | `integer` | The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched. |
| `qGroupSize` | `integer` | Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched. |
| `qRow` | `integer` | Row index in the data matrix. The indexing starts from 0. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qValues` | `array` of [NxTreeValue](#nxtreevalue) | The measures for this node. |
| `qNodes` | `array` of [NxTreeNode](#nxtreenode) | The children of this node in the fetched tree structure. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
| `qMaxPos` | `array of number` | Total of the positive values in the current group of cells. |
| `qMinNeg` | `array of number` | Total of the negative values in the current group of cells. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qState` | oneOf(L \| S \| O \| D \| A \| X \| XS \| XL \| NSTATES) | |
| `qTreePath` | `array of integer` | The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty. |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qMaxPos`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMinNeg`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qState`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
Properties of `qTreePath`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleValue](#nxsimplevalue) | List of attribute expressions values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleValue` | [NxSimpleValue](#nxsimplevalue) | |
Properties of `NxSimpleValue`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleDimValue](#nxsimpledimvalue) | List of values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleDimValue` | [NxSimpleDimValue](#nxsimpledimvalue) | |
Properties of `NxSimpleDimValue`
_Properties truncated due to depth limit._
Properties of `qMaxPos`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `number` | |
Properties of `qMinNeg`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `number` | |
Properties of `qState`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `L` | `object` | LOCKED |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | SELECTED |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `O` | `object` | OPTION |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DESELECTED |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ALTERNATIVE |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `X` | `object` | EXCLUDED |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `XS` | `object` | EXCL_SELECTED |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `XL` | `object` | EXCL_LOCKED |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `NSTATES` | `object` | |
Properties of `qTreePath`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### NxTreeRangeSelectInfo
| Name | Type | Description |
| --- | --- | --- |
| `qRange` | [Range](#range) | |
| `qMeasureIx` | `integer` | Number of the measure to select. Numbering starts from 0. |
| `qDimensionIx` | `integer` | Number of the dimension to select measure from. Numbering starts from 0. |
Properties of `qRange`
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Lowest value in the range |
| `qMax` | `number` | Highest value in the range |
| `qMinInclEq` | `boolean` | If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 1 is included in the range of selections. |
| `qMaxInclEq` | `boolean` | If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 10 is included in the range of selections. |
---
### NxTreeValue
Represents a measure.
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | The text version of the value, if available. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
Properties of `qAttrExps`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleValue](#nxsimplevalue) | List of attribute expressions values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleValue` | [NxSimpleValue](#nxsimplevalue) | |
Properties of `NxSimpleValue`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
| Name | Type | Description |
| --- | --- | --- |
| `qValues` | `array` of [NxSimpleDimValue](#nxsimpledimvalue) | List of values. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxSimpleDimValue` | [NxSimpleDimValue](#nxsimpledimvalue) | |
Properties of `NxSimpleDimValue`
_Properties truncated due to depth limit._
---
### NxTrendline
Information about the calculated trendline.
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(AVERAGE \| LINEAR \| POLYNOMIAL2 \| POLYNOMIAL3 \| POLYNOMIAL4 \| EXPONENTIAL \| POWER \| LOG) | |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qCoeff` | `array of number` | Coefficent c0..cN depending on the trendline type. |
| `qR2` | `number` | R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation. |
| `qExpression` | `string` | Trendline expression |
| `qElemNo` | `integer` | Inner Dim elem no |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `AVERAGE` | `object` | Average |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LINEAR` | `object` | Linear |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL2` | `object` | Polynomial2 |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL3` | `object` | Polynomial3 |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL4` | `object` | Polynomial4 |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `EXPONENTIAL` | `object` | Exponential |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `POWER` | `object` | Power |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG` | `object` | Logarithmic |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
Properties of `qCoeff`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `number` | |
---
### NxTrendlineDef
Trendline input definition
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(AVERAGE \| LINEAR \| POLYNOMIAL2 \| POLYNOMIAL3 \| POLYNOMIAL4 \| EXPONENTIAL \| POWER \| LOG) | |
| `qXColIx` | `integer` | The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure |
| `qCalcR2` | `boolean` | Set to true to calulatate the R2 score |
| `qContinuousXAxis` | oneOf(Never \| Possible \| Time) | |
| `qMultiDimMode` | oneOf(Multi \| Sum) | |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `AVERAGE` | `object` | Average |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LINEAR` | `object` | Linear |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL2` | `object` | Polynomial2 |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL3` | `object` | Polynomial3 |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `POLYNOMIAL4` | `object` | Polynomial4 |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `EXPONENTIAL` | `object` | Exponential |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `POWER` | `object` | Power |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `LOG` | `object` | Logarithmic |
Properties of `qContinuousXAxis`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Never` | `object` | CONTINUOUS_NEVER |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `Possible` | `object` | CONTINUOUS_IF_POSSIBLE |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `Time` | `object` | CONTINUOUS_IF_TIME |
Properties of `qMultiDimMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Multi` | `object` | TRENDLINE_MULTILINE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `Sum` | `object` | TRENDLINE_SUM |
---
### NxTrendlineMode
| Name | Type | Description |
| --- | --- | --- |
| `NxTrendlineMode` | oneOf(Multi \| Sum) | |
Properties of `NxTrendlineMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Multi` | `object` | TRENDLINE_MULTILINE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `Sum` | `object` | TRENDLINE_SUM |
---
### NxValidationError
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
---
### NxVariableListItem
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the variable. |
| `qDescription` | `string` | Description of the variable. |
| `qDefinition` | `string` | Definition of the variable. It can be a value or an expression. |
| `qIsConfig` | `boolean` | If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false. |
| `qIsReserved` | `boolean` | If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples: * _ScriptError_ is a reserved variable, set by the engine. * _DayNames_ is a reserved variable, set by the user. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
| `qIsScriptCreated` | `boolean` | If set to true, it means that the variable was defined via script. |
Properties of `qMeta`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name. This property is optional. |
Properties of `qInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `string` | Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional. |
| `qType` | `string` | Type of the object. This parameter is mandatory. |
---
### NxVariableProperties
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the variable. |
| `qNumberPresentation` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIncludeInBookmark` | `boolean` | Set this property to true to update the variable when applying a bookmark. The value of a variable can affect the state of the selections. The default value is false. |
| `qUsePredefListedValues` | `boolean` | The value of a variable can be an enumeration. Set this property to true to reflect the predefined values in an enumeration. |
| `qPreDefinedList` | `array of string` | List of enumerations. This property is used if _qUsePredefListedValues_ is set to true. |
Properties of `qNumberPresentation`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
Properties of `qPreDefinedList`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### NxViewPort
| Name | Type | Description |
| --- | --- | --- |
| `qWidth` | `integer` | Width of the canvas in pixels. |
| `qHeight` | `integer` | Height of the canvas in pixels. |
| `qZoomLevel` | `integer` | Zoom level. |
---
### ObjectInterface
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | The native type of the object. |
| `qHandle` | `integer` | The handle used to connect to object. |
| `qGenericType` | `string` | The type of the object. |
| `qGenericId` | `string` | Object ID. |
---
### OdbcDsn
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the ODBC connection. |
| `qDescription` | `string` | Description of the ODBC connection. |
| `qBit32` | `boolean` | Is set to true if the version of ODBC is 32-bit. This parameter is optional. Default is false. |
| `qUserOnly` | `boolean` | Is set to true if the connection is User DSN. The connection works only for a specific user. Default is false. This parameter is optional. |
---
### OleDbProvider
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the OLEDB provider. |
| `qDescription` | `string` | Description of the OLEDB provider. |
| `qBit32` | `boolean` | Is set to true if the version of the OLEDB provider is 32-bit. Default is false. This parameter is optional. |
---
### OtherLimitMode
| Name | Type | Description |
| --- | --- | --- |
| `OtherLimitMode` | oneOf(OTHER_GE_LIMIT \| OTHER_LE_LIMIT \| OTHER_GT_LIMIT \| OTHER_LT_LIMIT) | |
Properties of `OtherLimitMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GE_LIMIT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LE_LIMIT` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GT_LIMIT` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LT_LIMIT` | `object` | |
---
### OtherMode
| Name | Type | Description |
| --- | --- | --- |
| `OtherMode` | oneOf(OTHER_OFF \| OTHER_COUNTED \| OTHER_ABS_LIMITED \| OTHER_ABS_ACC_TARGET \| OTHER_REL_LIMITED \| OTHER_REL_ACC_TARGET) | |
Properties of `OtherMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_COUNTED` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_LIMITED` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_ACC_TARGET` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_LIMITED` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_ACC_TARGET` | `object` | |
---
### OtherSortMode
| Name | Type | Description |
| --- | --- | --- |
| `OtherSortMode` | oneOf(OTHER_SORT_DEFAULT \| OTHER_SORT_DESCENDING \| OTHER_SORT_ASCENDING) | |
Properties of `OtherSortMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DEFAULT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DESCENDING` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_ASCENDING` | `object` | |
---
### OtherTotalSpecProp
| Name | Type | Description |
| --- | --- | --- |
| `qOtherMode` | oneOf(OTHER_OFF \| OTHER_COUNTED \| OTHER_ABS_LIMITED \| OTHER_ABS_ACC_TARGET \| OTHER_REL_LIMITED \| OTHER_REL_ACC_TARGET) | |
| `qOtherCounted` | [ValueExpr](#valueexpr) | |
| `qOtherLimit` | [ValueExpr](#valueexpr) | |
| `qOtherLimitMode` | oneOf(OTHER_GE_LIMIT \| OTHER_LE_LIMIT \| OTHER_GT_LIMIT \| OTHER_LT_LIMIT) | |
| `qSuppressOther` | `boolean` | If set to true, the group _Others_ is not displayed as a dimension value. The default value is false. |
| `qForceBadValueKeeping` | `boolean` | This parameter is used when _qOtherMode_ is set to: * OTHER_ABS_LIMITED * OTHER_REL_LIMITED * OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true. |
| `qApplyEvenWhenPossiblyWrongResult` | `boolean` | Set this parameter to true to allow the calculation of _Others_ even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true. |
| `qGlobalOtherGrouping` | `boolean` | This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false. |
| `qOtherCollapseInnerDimensions` | `boolean` | If set to true, it collapses the inner dimensions (if any) in the group _Others_ . The default value is false. |
| `qOtherSortMode` | oneOf(OTHER_SORT_DEFAULT \| OTHER_SORT_DESCENDING \| OTHER_SORT_ASCENDING) | |
| `qTotalMode` | oneOf(TOTAL_OFF \| TOTAL_EXPR) | |
| `qReferencedExpression` | [StringExpr](#stringexpr) | |
Properties of `qOtherMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_COUNTED` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_LIMITED` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_ABS_ACC_TARGET` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_LIMITED` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_REL_ACC_TARGET` | `object` | |
Properties of `qOtherCounted`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherLimit`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qOtherLimitMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GE_LIMIT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LE_LIMIT` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_GT_LIMIT` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_LT_LIMIT` | `object` | |
Properties of `qOtherSortMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DEFAULT` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_DESCENDING` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `OTHER_SORT_ASCENDING` | `object` | |
Properties of `qTotalMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_EXPR` | `object` | |
Properties of `qReferencedExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
---
### Point
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | x-coordinate in pixels. The origin is the top left of the screen. |
| `qy` | `integer` | y-coordinate in pixels. The origin is the top left of the screen. |
---
### PositionMark
| Name | Type | Description |
| --- | --- | --- |
| `qDimName` | `string` | |
| `qElemNo` | `array of integer` | |
| `qElemValues` | `array` of [Blob](#blob) | |
Properties of `qElemNo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qElemValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `Blob` | [Blob](#blob) | |
---
### ProgressData
| Name | Type | Description |
| --- | --- | --- |
| `qStarted` | `boolean` | True if the request is started. |
| `qFinished` | `boolean` | True if the request is finished. |
| `qCompleted` | `integer` | This property is not used. |
| `qTotal` | `integer` | This property is not used. |
| `qKB` | `integer` | This property is not used. |
| `qMillisecs` | `integer` | Request duration in milliseconds. |
| `qUserInteractionWanted` | `boolean` | True when the engine pauses the script execution and waits for a user interaction. |
| `qPersistentProgress` | `string` | A progress message is persistent when it informs about the start or end of a statement. For example, it can inform about the total number of lines fetched from a data source or tell that the app was saved. All persistent progress messages between two *GetProgress* calls are summarized in this string. Contrarily to *qPersistentProgressMessages*, the content of the localized message string is displayed (not its message code). |
| `qTransientProgress` | `string` | A progress message is transient when it informs about the progress of an ongoing statement. For example, it can tell how many lines are currently fetched from a data source. All transient progress messages between two *GetProgress* calls are summarized in this string. Contrarily to *qTransientProgressMessage*, the content of the localized message string is displayed (not its message code). |
| `qErrorData` | `array` of [ErrorData](#errordata) | Information about the error messages that occur during the script execution. |
| `qPersistentProgressMessages` | `array` of [ProgressMessage](#progressmessage) | List of persistent progress messages. |
| `qTransientProgressMessage` | [ProgressMessage](#progressmessage) | |
Properties of `qErrorData`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ErrorData` | [ErrorData](#errordata) | |
Properties of `ErrorData`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorString` | `string` | Detailed information about the error message. |
| `qLineEnd` | `string` | Line termination characters. |
| `qLine` | `string` | Script statement where the error occurs. |
| `qErrorDataCode` | oneOf(EDC_ERROR \| EDC_WARNING \| EDC_CIRCULAR_REFERENCE) | |
| `qMessage` | [ProgressMessage](#progressmessage) | |
Properties of `qErrorDataCode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qMessage`
_Properties truncated due to depth limit._
Properties of `qPersistentProgressMessages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ProgressMessage` | [ProgressMessage](#progressmessage) | |
Properties of `ProgressMessage`
| Name | Type | Description |
| --- | --- | --- |
| `qMessageCode` | `integer` | Code number to the corresponding localized message string. |
| `qMessageParameters` | `array of string` | Parameters to be inserted in the localized message string. |
Properties of `qMessageParameters`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTransientProgressMessage`
| Name | Type | Description |
| --- | --- | --- |
| `qMessageCode` | `integer` | Code number to the corresponding localized message string. |
| `qMessageParameters` | `array of string` | Parameters to be inserted in the localized message string. |
Properties of `qMessageParameters`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### ProgressMessage
| Name | Type | Description |
| --- | --- | --- |
| `qMessageCode` | `integer` | Code number to the corresponding localized message string. |
| `qMessageParameters` | `array of string` | Parameters to be inserted in the localized message string. |
Properties of `qMessageParameters`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### Range
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Lowest value in the range |
| `qMax` | `number` | Highest value in the range |
| `qMinInclEq` | `boolean` | If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 1 is included in the range of selections. |
| `qMaxInclEq` | `boolean` | If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 10 is included in the range of selections. |
---
### RangeSelectInfo
| Name | Type | Description |
| --- | --- | --- |
| `qRangeLo` | `number` | Lowest value in the range. |
| `qRangeHi` | `number` | Highest value in the range. |
| `qMeasure` | `string` | Label of the measure. |
---
### Rect
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
---
### ReloadError
| Name | Type | Description |
| --- | --- | --- |
| `qError` | `string` | Type of error. |
| `qDescription` | `string` | Description of error. |
| `qLine` | `string` | Script line text where error occurred. |
| `qLineNumber` | `integer` | Script line number where error occurred (zero-based). |
| `qCode` | `integer` | Error code. |
| `qTitle` | oneOf(LOCERR_INTERNAL_ERROR \| LOCERR_GENERIC_UNKNOWN \| LOCERR_GENERIC_OK \| LOCERR_GENERIC_NOT_SET \| LOCERR_GENERIC_NOT_FOUND \| LOCERR_GENERIC_ALREADY_EXISTS \| LOCERR_GENERIC_INVALID_PATH \| LOCERR_GENERIC_ACCESS_DENIED \| LOCERR_GENERIC_OUT_OF_MEMORY \| LOCERR_GENERIC_NOT_INITIALIZED \| LOCERR_GENERIC_INVALID_PARAMETERS \| LOCERR_GENERIC_EMPTY_PARAMETERS \| LOCERR_GENERIC_INTERNAL_ERROR \| LOCERR_GENERIC_CORRUPT_DATA \| LOCERR_GENERIC_MEMORY_INCONSISTENCY \| LOCERR_GENERIC_INVISIBLE_OWNER_ABORT \| LOCERR_GENERIC_PROHIBIT_VALIDATE \| LOCERR_GENERIC_ABORTED \| LOCERR_GENERIC_CONNECTION_LOST \| LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION \| LOCERR_GENERIC_REST_CONNECTION_FAILURE \| LOCERR_GENERIC_MEMORY_LIMIT_REACHED \| LOCERR_GENERIC_NOT_IMPLEMENTED \| LOCERR_GENERIC_ENGINE_TERMINATED \| LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED \| LOCERR_HTTP_400 \| LOCERR_HTTP_401 \| LOCERR_HTTP_402 \| LOCERR_HTTP_403 \| LOCERR_HTTP_404 \| LOCERR_HTTP_405 \| LOCERR_HTTP_406 \| LOCERR_HTTP_407 \| LOCERR_HTTP_408 \| LOCERR_HTTP_409 \| LOCERR_HTTP_410 \| LOCERR_HTTP_411 \| LOCERR_HTTP_412 \| LOCERR_HTTP_413 \| LOCERR_HTTP_414 \| LOCERR_HTTP_415 \| LOCERR_HTTP_416 \| LOCERR_HTTP_417 \| LOCERR_HTTP_422 \| LOCERR_HTTP_423 \| LOCERR_HTTP_429 \| LOCERR_HTTP_500 \| LOCERR_HTTP_501 \| LOCERR_HTTP_502 \| LOCERR_HTTP_503 \| LOCERR_HTTP_504 \| LOCERR_HTTP_505 \| LOCERR_HTTP_509 \| LOCERR_HTTP_COULD_NOT_RESOLVE_HOST \| LOCERR_APP_ALREADY_EXISTS \| LOCERR_APP_INVALID_NAME \| LOCERR_APP_ALREADY_OPEN \| LOCERR_APP_NOT_FOUND \| LOCERR_APP_IMPORT_FAILED \| LOCERR_APP_SAVE_FAILED \| LOCERR_APP_CREATE_FAILED \| LOCERR_APP_INVALID \| LOCERR_APP_CONNECT_FAILED \| LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE \| LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE \| LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION \| LOCERR_APP_MIGRATION_FAILURE \| LOCERR_APP_SCRIPT_MISSING \| LOCERR_APP_EXPORT_FAILED \| LOCERR_APP_SIZE_EXCEEDED \| LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED \| LOCERR_APP_NOT_OPEN \| LOCERR_APP_EVENT_SOURCE_TIMEOUT \| LOCERR_CONNECTION_ALREADY_EXISTS \| LOCERR_CONNECTION_NOT_FOUND \| LOCERR_CONNECTION_FAILED_TO_LOAD \| LOCERR_CONNECTION_FAILED_TO_IMPORT \| LOCERR_CONNECTION_NAME_IS_INVALID \| LOCERR_CONNECTION_MISSING_CREDENTIALS \| LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT \| LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE \| LOCERR_FILE_ACCESS_DENIED \| LOCERR_FILE_NAME_INVALID \| LOCERR_FILE_CORRUPT \| LOCERR_FILE_NOT_FOUND \| LOCERR_FILE_FORMAT_UNSUPPORTED \| LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE \| LOCERR_FILE_TABLE_NOT_FOUND \| LOCERR_USER_ACCESS_DENIED \| LOCERR_USER_IMPERSONATION_FAILED \| LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS \| LOCERR_SERVER_OUT_OF_SESSION_CALS \| LOCERR_SERVER_OUT_OF_USAGE_CALS \| LOCERR_SERVER_OUT_OF_CALS \| LOCERR_SERVER_OUT_OF_NAMED_CALS \| LOCERR_SERVER_OFF_DUTY \| LOCERR_SERVER_BUSY \| LOCERR_SERVER_LICENSE_EXPIRED \| LOCERR_SERVER_AJAX_DISABLED \| LOCERR_SERVER_NO_TOKEN \| LOCERR_HC_INVALID_OBJECT \| LOCERR_HC_RESULT_TOO_LARGE \| LOCERR_HC_INVALID_OBJECT_STATE \| LOCERR_HC_MODAL_OBJECT_ERROR \| LOCERR_CALC_INVALID_DEF \| LOCERR_CALC_NOT_IN_LIB \| LOCERR_CALC_HEAP_ERROR \| LOCERR_CALC_TOO_LARGE \| LOCERR_CALC_TIMEOUT \| LOCERR_CALC_EVAL_CONDITION_FAILED \| LOCERR_CALC_MIXED_LINKED_AGGREGATION \| LOCERR_CALC_MISSING_LINKED \| LOCERR_CALC_INVALID_COL_SORT \| LOCERR_CALC_PAGES_TOO_LARGE \| LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED \| LOCERR_CALC_VALIDATION_STATE_INVALID \| LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS \| LOCERR_CALC_MISSING_LINKED_FIELD \| LOCERR_CALC_NOT_CALCULATED \| LOCERR_LAYOUT_EXTENDS_INVALID_ID \| LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND \| LOCERR_LAYOUT_LINKED_OBJECT_INVALID \| LOCERR_PERSISTENCE_WRITE_FAILED \| LOCERR_PERSISTENCE_READ_FAILED \| LOCERR_PERSISTENCE_DELETE_FAILED \| LOCERR_PERSISTENCE_NOT_FOUND \| LOCERR_PERSISTENCE_UNSUPPORTED_VERSION \| LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY \| LOCERR_PERSISTENCE_MIGRATION_CANCELLED \| LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED \| LOCERR_PERSISTENCE_DISK_FULL \| LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP \| LOCERR_PERSISTENCE_MOVE_FAILED \| LOCERR_PERSISTENCE_OBJECT_LOCKED \| LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING \| LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS \| LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS \| LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED \| LOCERR_RELOAD_IN_PROGRESS \| LOCERR_RELOAD_TABLE_X_NOT_FOUND \| LOCERR_RELOAD_UNKNOWN_STATEMENT \| LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN \| LOCERR_RELOAD_FIELD_X_NOT_FOUND \| LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND \| LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND \| LOCERR_RELOAD_NAME_ALREADY_TAKEN \| LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF \| LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF \| LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED \| LOCERR_RELOAD_OPEN_FILE_ERROR \| LOCERR_RELOAD_AUTO_GENERATE_COUNT \| LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB \| LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR \| LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND \| LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID \| LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE \| LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE \| LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS \| LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS \| LOCERR_RELOAD_NO_OPEN_DATABASE \| LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY \| LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE \| LOCERR_RELOAD_ODBC_CONNECT_FAILED \| LOCERR_RELOAD_OLEDB_CONNECT_FAILED \| LOCERR_RELOAD_CUSTOM_CONNECT_FAILED \| LOCERR_RELOAD_ODBC_READ_FAILED \| LOCERR_RELOAD_OLEDB_READ_FAILED \| LOCERR_RELOAD_CUSTOM_READ_FAILED \| LOCERR_RELOAD_BINARY_LOAD_PROHIBITED \| LOCERR_RELOAD_CONNECTOR_START_FAILED \| LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING \| LOCERR_RELOAD_CONNECTOR_REPLY_ERROR \| LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR \| LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR \| LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS \| LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE \| LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD \| LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT \| LOCERR_RELOAD_EXIT_ERROR \| LOCERR_PERSONAL_NEW_VERSION_AVAILABLE \| LOCERR_PERSONAL_VERSION_EXPIRED \| LOCERR_PERSONAL_SECTION_ACCESS_DETECTED \| LOCERR_PERSONAL_APP_DELETION_FAILED \| LOCERR_USER_AUTHENTICATION_FAILURE \| LOCERR_EXPORT_OUT_OF_MEMORY \| LOCERR_EXPORT_NO_DATA \| LOCERR_SYNC_INVALID_OFFSET \| LOCERR_SEARCH_TIMEOUT \| LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL \| LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW \| LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT \| LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED \| LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED \| LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED \| LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED \| LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED \| LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED \| LOCERR_SMART_LOAD_TABLE_NOT_FOUND \| LOCERR_SMART_LOAD_TABLE_DUPLICATED \| LOCERR_VARIABLE_NO_NAME \| LOCERR_VARIABLE_DUPLICATE_NAME \| LOCERR_VARIABLE_INCONSISTENCY \| LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY \| LOCERR_VARIABLE_CONSTRAINT_FAILED \| LOCERR_MEDIA_LIBRARY_LIST_FAILED \| LOCERR_MEDIA_LIBRARY_CONTENT_FAILED \| LOCERR_MEDIA_BUNDLING_FAILED \| LOCERR_MEDIA_UNBUNDLING_FAILED \| LOCERR_MEDIA_LIBRARY_NOT_FOUND \| LOCERR_FEATURE_DISABLED \| LOCERR_LOAD_TOO_MANY_FIELDS \| LOCERR_LOAD_TOO_MANY_TABLES \| LOCERR_JSON_RPC_INVALID_REQUEST \| LOCERR_JSON_RPC_METHOD_NOT_FOUND \| LOCERR_JSON_RPC_INVALID_PARAMETERS \| LOCERR_JSON_RPC_INTERNAL_ERROR \| LOCERR_JSON_RPC_RESPONSE_TOO_LARGE \| LOCERR_JSON_RPC_PARSE_ERROR \| LOCERR_MQ_SOCKET_CONNECT_FAILURE \| LOCERR_MQ_SOCKET_OPEN_FAILURE \| LOCERR_MQ_PROTOCOL_NO_RESPONE \| LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION \| LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED \| LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED \| LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR \| LOCERR_MQ_PROTOCOL_INVALID_STATUS \| LOCERR_EXTENGINE_GRPC_STATUS_OK \| LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED \| LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN \| LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT \| LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED \| LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND \| LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS \| LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED \| LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED \| LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION \| LOCERR_EXTENGINE_GRPC_STATUS_ABORTED \| LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE \| LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED \| LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL \| LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE \| LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS \| LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED \| LOCERR_LXW_INVALID_OBJ \| LOCERR_LXW_INVALID_FILE \| LOCERR_LXW_INVALID_SHEET \| LOCERR_LXW_INVALID_EXPORT_RANGE \| LOCERR_LXW_ERROR \| LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED \| LOCERR_LXW_ERROR_CREATING_XLSX_FILE \| LOCERR_LXW_ERROR_CREATING_TMPFILE \| LOCERR_LXW_ERROR_ZIP_FILE_OPERATION \| LOCERR_LXW_ERROR_ZIP_FILE_ADD \| LOCERR_LXW_ERROR_ZIP_CLOSE \| LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED \| LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED \| LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED \| LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND \| LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE \| LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED \| LOCERR_BDI_STATUS_OK \| LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED \| LOCERR_TRENDLINE_INVALID_DEF \| LOCERR_TRENDLINE_INVALID_MATH_ERROR \| LOCERR_CURL_UNSUPPORTED_PROTOCOL \| LOCERR_CURL_COULDNT_RESOLVE_PROXY \| LOCERR_CURL_COULDNT_CONNECT \| LOCERR_CURL_REMOTE_ACCESS_DENIED \| LOCERR_CURL_FTP_ACCEPT_FAILED \| LOCERR_CURL_FTP_ACCEPT_TIMEOUT \| LOCERR_CURL_FTP_CANT_GET_HOST \| LOCERR_CURL_PARTIAL_FILE \| LOCERR_CURL_QUOTE_ERROR \| LOCERR_CURL_WRITE_ERROR \| LOCERR_CURL_UPLOAD_FAILED \| LOCERR_CURL_OUT_OF_MEMORY \| LOCERR_CURL_OPERATION_TIMEDOUT \| LOCERR_CURL_FTP_COULDNT_USE_REST \| LOCERR_CURL_HTTP_POST_ERROR \| LOCERR_CURL_SSL_CONNECT_ERROR \| LOCERR_CURL_FILE_COULDNT_READ_FILE \| LOCERR_CURL_LDAP_CANNOT_BIND \| LOCERR_CURL_LDAP_SEARCH_FAILED \| LOCERR_CURL_TOO_MANY_REDIRECTS \| LOCERR_CURL_PEER_FAILED_VERIFICATION \| LOCERR_CURL_GOT_NOTHING \| LOCERR_CURL_SSL_ENGINE_NOTFOUND \| LOCERR_CURL_SSL_ENGINE_SETFAILED \| LOCERR_CURL_SSL_CERTPROBLEM \| LOCERR_CURL_SSL_CIPHER \| LOCERR_CURL_SSL_CACERT \| LOCERR_CURL_BAD_CONTENT_ENCODING \| LOCERR_CURL_LDAP_INVALID_URL \| LOCERR_CURL_USE_SSL_FAILED \| LOCERR_CURL_SSL_ENGINE_INITFAILED \| LOCERR_CURL_LOGIN_DENIED \| LOCERR_CURL_TFTP_NOTFOUND \| LOCERR_CURL_TFTP_ILLEGAL \| LOCERR_CURL_SSH \| LOCERR_SETEXPRESSION_TOO_LARGE \| LOCERR_RELOAD_MERGE_LOAD_ERROR \| LOCERR_WIN_FTP_DROPPED \| LOCERR_WIN_FTP_NO_PASSIVE_MODE \| LOCERR_WIN_HTTP_DOWNLEVEL_SERVER \| LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE \| LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION \| LOCERR_WIN_INTERNET_FORCE_RETRY \| LOCERR_WIN_INTERNET_CANNOT_CONNECT \| LOCERR_WIN_INTERNET_CONNECTION_ABORTED \| LOCERR_WIN_INTERNET_CONNECTION_RESET \| LOCERR_WIN_INTERNET_DISCONNECTED \| LOCERR_WIN_INTERNET_INCORRECT_FORMAT \| LOCERR_WIN_INTERNET_INVALID_CA \| LOCERR_WIN_INTERNET_INVALID_OPERATION \| LOCERR_WIN_INTERNET_INVALID_URL \| LOCERR_WIN_INTERNET_ITEM_NOT_FOUND \| LOCERR_WIN_INTERNET_LOGIN_FAILURE \| LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED \| LOCERR_WIN_INTERNET_NEED_UI \| LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID \| LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID \| LOCERR_WIN_INTERNET_SEC_CERT_ERRORS \| LOCERR_WIN_INTERNET_SEC_INVALID_CERT \| LOCERR_WIN_INTERNET_SERVER_UNREACHABLE \| LOCERR_BM_RESULT_TOO_LARGE) | |
Properties of `qTitle`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_INTERNAL_ERROR` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_UNKNOWN` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_OK` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_SET` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_FOUND` | `object` | |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ALREADY_EXISTS` | `object` | |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVALID_PATH` | `object` | |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ACCESS_DENIED` | `object` | |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_OUT_OF_MEMORY` | `object` | |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_INITIALIZED` | `object` | |
**Option 11:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVALID_PARAMETERS` | `object` | |
**Option 12:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_EMPTY_PARAMETERS` | `object` | |
**Option 13:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INTERNAL_ERROR` | `object` | |
**Option 14:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_CORRUPT_DATA` | `object` | |
**Option 15:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_MEMORY_INCONSISTENCY` | `object` | |
**Option 16:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_INVISIBLE_OWNER_ABORT` | `object` | |
**Option 17:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_PROHIBIT_VALIDATE` | `object` | |
**Option 18:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ABORTED` | `object` | |
**Option 19:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_CONNECTION_LOST` | `object` | |
**Option 20:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION` | `object` | |
**Option 21:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_REST_CONNECTION_FAILURE` | `object` | |
**Option 22:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_MEMORY_LIMIT_REACHED` | `object` | |
**Option 23:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_NOT_IMPLEMENTED` | `object` | |
**Option 24:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_ENGINE_TERMINATED` | `object` | |
**Option 25:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED` | `object` | |
**Option 26:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_400` | `object` | |
**Option 27:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_401` | `object` | |
**Option 28:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_402` | `object` | |
**Option 29:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_403` | `object` | |
**Option 30:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_404` | `object` | |
**Option 31:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_405` | `object` | |
**Option 32:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_406` | `object` | |
**Option 33:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_407` | `object` | |
**Option 34:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_408` | `object` | |
**Option 35:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_409` | `object` | |
**Option 36:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_410` | `object` | |
**Option 37:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_411` | `object` | |
**Option 38:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_412` | `object` | |
**Option 39:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_413` | `object` | |
**Option 40:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_414` | `object` | |
**Option 41:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_415` | `object` | |
**Option 42:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_416` | `object` | |
**Option 43:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_417` | `object` | |
**Option 44:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_422` | `object` | |
**Option 45:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_423` | `object` | |
**Option 46:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_429` | `object` | |
**Option 47:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_500` | `object` | |
**Option 48:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_501` | `object` | |
**Option 49:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_502` | `object` | |
**Option 50:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_503` | `object` | |
**Option 51:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_504` | `object` | |
**Option 52:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_505` | `object` | |
**Option 53:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_509` | `object` | |
**Option 54:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HTTP_COULD_NOT_RESOLVE_HOST` | `object` | |
**Option 55:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_EXISTS` | `object` | |
**Option 56:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_INVALID_NAME` | `object` | |
**Option 57:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_OPEN` | `object` | |
**Option 58:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_NOT_FOUND` | `object` | |
**Option 59:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_IMPORT_FAILED` | `object` | |
**Option 60:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SAVE_FAILED` | `object` | |
**Option 61:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_CREATE_FAILED` | `object` | |
**Option 62:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_INVALID` | `object` | |
**Option 63:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_CONNECT_FAILED` | `object` | |
**Option 64:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE` | `object` | |
**Option 65:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE` | `object` | |
**Option 66:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION` | `object` | |
**Option 67:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_MIGRATION_FAILURE` | `object` | |
**Option 68:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SCRIPT_MISSING` | `object` | |
**Option 69:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_EXPORT_FAILED` | `object` | |
**Option 70:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_SIZE_EXCEEDED` | `object` | |
**Option 71:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED` | `object` | |
**Option 72:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_NOT_OPEN` | `object` | |
**Option 73:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_APP_EVENT_SOURCE_TIMEOUT` | `object` | |
**Option 74:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_ALREADY_EXISTS` | `object` | |
**Option 75:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_NOT_FOUND` | `object` | |
**Option 76:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_FAILED_TO_LOAD` | `object` | |
**Option 77:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_FAILED_TO_IMPORT` | `object` | |
**Option 78:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_NAME_IS_INVALID` | `object` | |
**Option 79:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTION_MISSING_CREDENTIALS` | `object` | |
**Option 80:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT` | `object` | |
**Option 81:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE` | `object` | |
**Option 82:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_ACCESS_DENIED` | `object` | |
**Option 83:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_NAME_INVALID` | `object` | |
**Option 84:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_CORRUPT` | `object` | |
**Option 85:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_NOT_FOUND` | `object` | |
**Option 86:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_FORMAT_UNSUPPORTED` | `object` | |
**Option 87:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE` | `object` | |
**Option 88:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FILE_TABLE_NOT_FOUND` | `object` | |
**Option 89:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_ACCESS_DENIED` | `object` | |
**Option 90:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_IMPERSONATION_FAILED` | `object` | |
**Option 91:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS` | `object` | |
**Option 92:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_SESSION_CALS` | `object` | |
**Option 93:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_USAGE_CALS` | `object` | |
**Option 94:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_CALS` | `object` | |
**Option 95:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OUT_OF_NAMED_CALS` | `object` | |
**Option 96:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_OFF_DUTY` | `object` | |
**Option 97:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_BUSY` | `object` | |
**Option 98:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_LICENSE_EXPIRED` | `object` | |
**Option 99:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_AJAX_DISABLED` | `object` | |
**Option 100:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SERVER_NO_TOKEN` | `object` | |
**Option 101:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_INVALID_OBJECT` | `object` | |
**Option 102:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_RESULT_TOO_LARGE` | `object` | |
**Option 103:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_INVALID_OBJECT_STATE` | `object` | |
**Option 104:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_HC_MODAL_OBJECT_ERROR` | `object` | |
**Option 105:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_INVALID_DEF` | `object` | |
**Option 106:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_NOT_IN_LIB` | `object` | |
**Option 107:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_HEAP_ERROR` | `object` | |
**Option 108:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_TOO_LARGE` | `object` | |
**Option 109:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_TIMEOUT` | `object` | |
**Option 110:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_EVAL_CONDITION_FAILED` | `object` | |
**Option 111:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MIXED_LINKED_AGGREGATION` | `object` | |
**Option 112:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MISSING_LINKED` | `object` | |
**Option 113:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_INVALID_COL_SORT` | `object` | |
**Option 114:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_PAGES_TOO_LARGE` | `object` | |
**Option 115:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED` | `object` | |
**Option 116:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_VALIDATION_STATE_INVALID` | `object` | |
**Option 117:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS` | `object` | |
**Option 118:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_MISSING_LINKED_FIELD` | `object` | |
**Option 119:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CALC_NOT_CALCULATED` | `object` | |
**Option 120:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_EXTENDS_INVALID_ID` | `object` | |
**Option 121:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND` | `object` | |
**Option 122:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LAYOUT_LINKED_OBJECT_INVALID` | `object` | |
**Option 123:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_WRITE_FAILED` | `object` | |
**Option 124:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_READ_FAILED` | `object` | |
**Option 125:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_DELETE_FAILED` | `object` | |
**Option 126:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_NOT_FOUND` | `object` | |
**Option 127:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_UNSUPPORTED_VERSION` | `object` | |
**Option 128:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY` | `object` | |
**Option 129:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_CANCELLED` | `object` | |
**Option 130:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED` | `object` | |
**Option 131:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_DISK_FULL` | `object` | |
**Option 132:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP` | `object` | |
**Option 133:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_MOVE_FAILED` | `object` | |
**Option 134:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_OBJECT_LOCKED` | `object` | |
**Option 135:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING` | `object` | |
**Option 136:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS` | `object` | |
**Option 137:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS` | `object` | |
**Option 138:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED` | `object` | |
**Option 139:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_IN_PROGRESS` | `object` | |
**Option 140:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_TABLE_X_NOT_FOUND` | `object` | |
**Option 141:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_UNKNOWN_STATEMENT` | `object` | |
**Option 142:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN` | `object` | |
**Option 143:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN` | `object` | |
**Option 144:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 145:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 146:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 147:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 148:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 149:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 150:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 151:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN` | `object` | |
**Option 152:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_FIELD_X_NOT_FOUND` | `object` | |
**Option 153:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND` | `object` | |
**Option 154:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND` | `object` | |
**Option 155:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NAME_ALREADY_TAKEN` | `object` | |
**Option 156:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF` | `object` | |
**Option 157:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF` | `object` | |
**Option 158:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED` | `object` | |
**Option 159:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OPEN_FILE_ERROR` | `object` | |
**Option 160:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_AUTO_GENERATE_COUNT` | `object` | |
**Option 161:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB` | `object` | |
**Option 162:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR` | `object` | |
**Option 163:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND` | `object` | |
**Option 164:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID` | `object` | |
**Option 165:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE` | `object` | |
**Option 166:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE` | `object` | |
**Option 167:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS` | `object` | |
**Option 168:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS` | `object` | |
**Option 169:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_NO_OPEN_DATABASE` | `object` | |
**Option 170:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY` | `object` | |
**Option 171:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE` | `object` | |
**Option 172:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ODBC_CONNECT_FAILED` | `object` | |
**Option 173:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OLEDB_CONNECT_FAILED` | `object` | |
**Option 174:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CUSTOM_CONNECT_FAILED` | `object` | |
**Option 175:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ODBC_READ_FAILED` | `object` | |
**Option 176:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_OLEDB_READ_FAILED` | `object` | |
**Option 177:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CUSTOM_READ_FAILED` | `object` | |
**Option 178:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_BINARY_LOAD_PROHIBITED` | `object` | |
**Option 179:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_START_FAILED` | `object` | |
**Option 180:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING` | `object` | |
**Option 181:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_REPLY_ERROR` | `object` | |
**Option 182:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR` | `object` | |
**Option 183:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR` | `object` | |
**Option 184:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS` | `object` | |
**Option 185:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE` | `object` | |
**Option 186:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD` | `object` | |
**Option 187:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT` | `object` | |
**Option 188:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_EXIT_ERROR` | `object` | |
**Option 189:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_NEW_VERSION_AVAILABLE` | `object` | |
**Option 190:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_VERSION_EXPIRED` | `object` | |
**Option 191:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_SECTION_ACCESS_DETECTED` | `object` | |
**Option 192:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_PERSONAL_APP_DELETION_FAILED` | `object` | |
**Option 193:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_USER_AUTHENTICATION_FAILURE` | `object` | |
**Option 194:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXPORT_OUT_OF_MEMORY` | `object` | |
**Option 195:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXPORT_NO_DATA` | `object` | |
**Option 196:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SYNC_INVALID_OFFSET` | `object` | |
**Option 197:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SEARCH_TIMEOUT` | `object` | |
**Option 198:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL` | `object` | |
**Option 199:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW` | `object` | |
**Option 200:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT` | `object` | |
**Option 201:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED` | `object` | |
**Option 202:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED` | `object` | |
**Option 203:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED` | `object` | |
**Option 204:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED` | `object` | |
**Option 205:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED` | `object` | |
**Option 206:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED` | `object` | |
**Option 207:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SMART_LOAD_TABLE_NOT_FOUND` | `object` | |
**Option 208:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SMART_LOAD_TABLE_DUPLICATED` | `object` | |
**Option 209:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_NO_NAME` | `object` | |
**Option 210:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_DUPLICATE_NAME` | `object` | |
**Option 211:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_INCONSISTENCY` | `object` | |
**Option 212:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY` | `object` | |
**Option 213:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_VARIABLE_CONSTRAINT_FAILED` | `object` | |
**Option 214:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_LIST_FAILED` | `object` | |
**Option 215:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_CONTENT_FAILED` | `object` | |
**Option 216:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_BUNDLING_FAILED` | `object` | |
**Option 217:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_UNBUNDLING_FAILED` | `object` | |
**Option 218:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MEDIA_LIBRARY_NOT_FOUND` | `object` | |
**Option 219:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_FEATURE_DISABLED` | `object` | |
**Option 220:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LOAD_TOO_MANY_FIELDS` | `object` | |
**Option 221:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LOAD_TOO_MANY_TABLES` | `object` | |
**Option 222:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INVALID_REQUEST` | `object` | |
**Option 223:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_METHOD_NOT_FOUND` | `object` | |
**Option 224:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INVALID_PARAMETERS` | `object` | |
**Option 225:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_INTERNAL_ERROR` | `object` | |
**Option 226:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_RESPONSE_TOO_LARGE` | `object` | |
**Option 227:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_JSON_RPC_PARSE_ERROR` | `object` | |
**Option 228:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_SOCKET_CONNECT_FAILURE` | `object` | |
**Option 229:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_SOCKET_OPEN_FAILURE` | `object` | |
**Option 230:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_NO_RESPONE` | `object` | |
**Option 231:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION` | `object` | |
**Option 232:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED` | `object` | |
**Option 233:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED` | `object` | |
**Option 234:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR` | `object` | |
**Option 235:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_MQ_PROTOCOL_INVALID_STATUS` | `object` | |
**Option 236:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_OK` | `object` | |
**Option 237:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED` | `object` | |
**Option 238:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN` | `object` | |
**Option 239:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT` | `object` | |
**Option 240:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED` | `object` | |
**Option 241:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND` | `object` | |
**Option 242:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS` | `object` | |
**Option 243:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED` | `object` | |
**Option 244:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED` | `object` | |
**Option 245:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION` | `object` | |
**Option 246:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_ABORTED` | `object` | |
**Option 247:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE` | `object` | |
**Option 248:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED` | `object` | |
**Option 249:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL` | `object` | |
**Option 250:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE` | `object` | |
**Option 251:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS` | `object` | |
**Option 252:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED` | `object` | |
**Option 253:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_OBJ` | `object` | |
**Option 254:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_FILE` | `object` | |
**Option 255:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_SHEET` | `object` | |
**Option 256:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_INVALID_EXPORT_RANGE` | `object` | |
**Option 257:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR` | `object` | |
**Option 258:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED` | `object` | |
**Option 259:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_CREATING_XLSX_FILE` | `object` | |
**Option 260:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_CREATING_TMPFILE` | `object` | |
**Option 261:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_FILE_OPERATION` | `object` | |
**Option 262:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_FILE_ADD` | `object` | |
**Option 263:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_ZIP_CLOSE` | `object` | |
**Option 264:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED` | `object` | |
**Option 265:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED` | `object` | |
**Option 266:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED` | `object` | |
**Option 267:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND` | `object` | |
**Option 268:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE` | `object` | |
**Option 269:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED` | `object` | |
**Option 270:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BDI_STATUS_OK` | `object` | |
**Option 271:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED` | `object` | |
**Option 272:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_TRENDLINE_INVALID_DEF` | `object` | |
**Option 273:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_TRENDLINE_INVALID_MATH_ERROR` | `object` | |
**Option 274:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_UNSUPPORTED_PROTOCOL` | `object` | |
**Option 275:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_COULDNT_RESOLVE_PROXY` | `object` | |
**Option 276:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_COULDNT_CONNECT` | `object` | |
**Option 277:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_REMOTE_ACCESS_DENIED` | `object` | |
**Option 278:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_ACCEPT_FAILED` | `object` | |
**Option 279:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_ACCEPT_TIMEOUT` | `object` | |
**Option 280:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_CANT_GET_HOST` | `object` | |
**Option 281:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_PARTIAL_FILE` | `object` | |
**Option 282:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_QUOTE_ERROR` | `object` | |
**Option 283:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_WRITE_ERROR` | `object` | |
**Option 284:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_UPLOAD_FAILED` | `object` | |
**Option 285:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_OUT_OF_MEMORY` | `object` | |
**Option 286:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_OPERATION_TIMEDOUT` | `object` | |
**Option 287:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FTP_COULDNT_USE_REST` | `object` | |
**Option 288:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_HTTP_POST_ERROR` | `object` | |
**Option 289:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CONNECT_ERROR` | `object` | |
**Option 290:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_FILE_COULDNT_READ_FILE` | `object` | |
**Option 291:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_CANNOT_BIND` | `object` | |
**Option 292:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_SEARCH_FAILED` | `object` | |
**Option 293:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TOO_MANY_REDIRECTS` | `object` | |
**Option 294:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_PEER_FAILED_VERIFICATION` | `object` | |
**Option 295:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_GOT_NOTHING` | `object` | |
**Option 296:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_NOTFOUND` | `object` | |
**Option 297:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_SETFAILED` | `object` | |
**Option 298:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CERTPROBLEM` | `object` | |
**Option 299:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CIPHER` | `object` | |
**Option 300:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_CACERT` | `object` | |
**Option 301:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_BAD_CONTENT_ENCODING` | `object` | |
**Option 302:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LDAP_INVALID_URL` | `object` | |
**Option 303:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_USE_SSL_FAILED` | `object` | |
**Option 304:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSL_ENGINE_INITFAILED` | `object` | |
**Option 305:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_LOGIN_DENIED` | `object` | |
**Option 306:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TFTP_NOTFOUND` | `object` | |
**Option 307:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_TFTP_ILLEGAL` | `object` | |
**Option 308:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_CURL_SSH` | `object` | |
**Option 309:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_SETEXPRESSION_TOO_LARGE` | `object` | |
**Option 310:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_RELOAD_MERGE_LOAD_ERROR` | `object` | |
**Option 311:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_FTP_DROPPED` | `object` | |
**Option 312:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_FTP_NO_PASSIVE_MODE` | `object` | |
**Option 313:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_DOWNLEVEL_SERVER` | `object` | |
**Option 314:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE` | `object` | |
**Option 315:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION` | `object` | |
**Option 316:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_FORCE_RETRY` | `object` | |
**Option 317:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CANNOT_CONNECT` | `object` | |
**Option 318:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CONNECTION_ABORTED` | `object` | |
**Option 319:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_CONNECTION_RESET` | `object` | |
**Option 320:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_DISCONNECTED` | `object` | |
**Option 321:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INCORRECT_FORMAT` | `object` | |
**Option 322:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_CA` | `object` | |
**Option 323:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_OPERATION` | `object` | |
**Option 324:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_INVALID_URL` | `object` | |
**Option 325:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_ITEM_NOT_FOUND` | `object` | |
**Option 326:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_LOGIN_FAILURE` | `object` | |
**Option 327:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED` | `object` | |
**Option 328:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_NEED_UI` | `object` | |
**Option 329:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID` | `object` | |
**Option 330:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID` | `object` | |
**Option 331:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_CERT_ERRORS` | `object` | |
**Option 332:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SEC_INVALID_CERT` | `object` | |
**Option 333:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_WIN_INTERNET_SERVER_UNREACHABLE` | `object` | |
**Option 334:**
| Name | Type | Description |
| --- | --- | --- |
| `LOCERR_BM_RESULT_TOO_LARGE` | `object` | |
---
### SampleResult
| Name | Type | Description |
| --- | --- | --- |
| `qFieldOrColumn` | [FieldOrColumn](#fieldorcolumn) | |
| `qValues` | `array` of [FieldValue](#fieldvalue) | Matched values part of the sample. |
Properties of `qFieldOrColumn`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | Name of the field or column to be matched. |
| `qTableName` | `string` | Name of the table to be matched on. This parameter is optional. If TableName is set, FieldName represent the Table column with that name. If TableName is not set, FieldName represents the the field with that name. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldValue` | [FieldValue](#fieldvalue) | |
Properties of `FieldValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
---
### ScriptSyntaxError
| Name | Type | Description |
| --- | --- | --- |
| `qErrLen` | `integer` | Length of the word where the error is located. |
| `qTabIx` | `integer` | Number of the faulty section. |
| `qLineInTab` | `integer` | Line number in the section where the error is located. |
| `qColInLine` | `integer` | Position of the erroneous text from the beginning of the line. |
| `qTextPos` | `integer` | Position of the erroneous text from the beginning of the script. |
| `qSecondaryFailure` | `boolean` | The default value is false. |
---
### ScrollPosition
| Name | Type | Description |
| --- | --- | --- |
| `qUsePosition` | `boolean` | |
| `qPos` | [Point](#point) | |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | x-coordinate in pixels. The origin is the top left of the screen. |
| `qy` | `integer` | y-coordinate in pixels. The origin is the top left of the screen. |
---
### SearchAssociationResult
| Name | Type | Description |
| --- | --- | --- |
| `qFieldNames` | `array of string` | List of the fields that contains search associations. |
| `qSearchTerms` | `array of string` | List of the search terms. |
| `qFieldDictionaries` | `array` of [SearchFieldDictionary](#searchfielddictionary) | Information about the fields containing search hits. |
| `qSearchTermsMatched` | `array` of [SearchMatchCombinations](#searchmatchcombinations) | List of search results. The maximum number of search results in this list is set by _qPage/qCount_ . |
| `qTotalSearchResults` | `integer` | Total number of search results. This number is not limited by _qPage/qCount_ . |
Properties of `qFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSearchTerms`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldDictionaries`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchFieldDictionary` | [SearchFieldDictionary](#searchfielddictionary) | |
Properties of `SearchFieldDictionary`
| Name | Type | Description |
| --- | --- | --- |
| `qField` | `integer` | Position of the field in the list of fields, starting from 0. The list of fields is defined in _qResults/qFieldNames_ and contains the search associations. |
| `qResult` | `array` of [SearchTermResult](#searchtermresult) | List of the matching values. The maximum number of values in this list is set by _qMaxNbrFieldMatches_ . |
Properties of `qResult`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qSearchTermsMatched`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchMatchCombinations` | [SearchMatchCombinations](#searchmatchcombinations) | |
Properties of `SearchMatchCombinations`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchMatchCombination` | [SearchMatchCombination](#searchmatchcombination) | |
Properties of `SearchMatchCombination`
_Properties truncated due to depth limit._
---
### SearchAttribute
| Name | Type | Description |
| --- | --- | --- |
| `qKey` | `string` | String corresponding to _SearchObjectOptions.qAttributes_. It will be _qProperty_ for _SearchObjectOptions_. |
| `qValue` | `string` | String corresponding to _qKey_ for the current _SearchGroupItemMatch_. For example, if the match is _Make by Price_ found in the title of a generic object, _qValue_ will be _qMetaDef/title_. |
---
### SearchCharRange
| Name | Type | Description |
| --- | --- | --- |
| `qCharPos` | `integer` | Starting position of the match in the search result, starting from 0. |
| `qCharCount` | `integer` | Length of the match in the search result. |
| `qTerm` | `integer` | Position of the term in the list of search terms, starting from 0. |
---
### SearchCombinationOptions
| Name | Type | Description |
| --- | --- | --- |
| `qSearchFields` | `array of string` | List of the search fields. If empty, the search is performed in all fields of the app. |
| `qContext` | oneOf(Cleared \| LockedFieldsOnly \| CurrentSelections) | |
| `qCharEncoding` | oneOf(Utf8 \| Utf16) | |
| `qAttributes` | `array of string` | Optional. * For SearchSuggest method, this array is empty. * For SearchObjects method, this array is empty or contain _qProperty_ . * For SearchResults method, this array is empty, or contains _qNum_ and/or _qElemNum_ . It allows the user to request details in the outputted _SearchGroupItemMatch_ . For more information, see _SearchGroupItemMatch_. |
Properties of `qSearchFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qContext`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Cleared` | `object` | CONTEXT_CLEARED |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LockedFieldsOnly` | `object` | CONTEXT_LOCKED_FIELDS_ONLY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `CurrentSelections` | `object` | CONTEXT_CURRENT_SELECTIONS |
Properties of `qCharEncoding`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Utf8` | `object` | CHAR_ENCODING_UTF8 |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `Utf16` | `object` | CHAR_ENCODING_UTF16 |
Properties of `qAttributes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### SearchContextType
| Name | Type | Description |
| --- | --- | --- |
| `SearchContextType` | oneOf(Cleared \| LockedFieldsOnly \| CurrentSelections) | |
Properties of `SearchContextType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Cleared` | `object` | CONTEXT_CLEARED |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `LockedFieldsOnly` | `object` | CONTEXT_LOCKED_FIELDS_ONLY |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `CurrentSelections` | `object` | CONTEXT_CURRENT_SELECTIONS |
---
### SearchFieldDictionary
| Name | Type | Description |
| --- | --- | --- |
| `qField` | `integer` | Position of the field in the list of fields, starting from 0. The list of fields is defined in _qResults/qFieldNames_ and contains the search associations. |
| `qResult` | `array` of [SearchTermResult](#searchtermresult) | List of the matching values. The maximum number of values in this list is set by _qMaxNbrFieldMatches_ . |
Properties of `qResult`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchTermResult` | [SearchTermResult](#searchtermresult) | |
Properties of `SearchTermResult`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text of the associated value. |
| `qElemNumber` | `integer` | Element number of the associated value. |
| `qRanges` | `array` of [SearchCharRange](#searchcharrange) | List of ranges. For example, if the user searches the term _read_ and the associative value is _Reading_ , then the corresponding range would be _Read_ in _Reading_ . |
Properties of `qRanges`
**Array items:**
_Properties truncated due to depth limit._
---
### SearchFieldMatch
| Name | Type | Description |
| --- | --- | --- |
| `qField` | `integer` | Position of the field in the list of fields, starting from 0. The list of fields is defined in _qResults/qFieldNames_ and contains the search associations. |
| `qValues` | `array of integer` | Positions of the matching values in the search results. The maximum number of values in this list is defined by _qMaxNbrFieldMatches_ . |
| `qTerms` | `array of integer` | Positions of the search terms, starting from 0. |
| `qNoOfMatches` | `integer` | Number of search hits in the field. The number of values in _qValues_ and the value of _qNoOfMatches_ are equal if _qMaxNbrFieldMatches_ is -1. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qTerms`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### SearchFieldMatchType
| Name | Type | Description |
| --- | --- | --- |
| `SearchFieldMatchType` | oneOf(FieldMatchNone \| FieldMatchSubString \| FieldMatchWord \| FieldMatchExact \| FieldMatchLast) | |
Properties of `SearchFieldMatchType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchNone` | `object` | FM_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchSubString` | `object` | FM_SUBSTRING |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchWord` | `object` | FM_WORD |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchExact` | `object` | FM_EXACT |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchLast` | `object` | FM_LAST |
---
### SearchFieldMatchesItem
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | |
| `qElemNo` | `integer` | |
| `qSearchTermsMatched` | `array of integer` | |
Properties of `qSearchTermsMatched`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
---
### SearchFieldSelectionMode
| Name | Type | Description |
| --- | --- | --- |
| `SearchFieldSelectionMode` | oneOf(OneAndOnlyOne) | |
Properties of `SearchFieldSelectionMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OneAndOnlyOne` | `object` | ONE_AND_ONLY_ONE |
---
### SearchFieldValueItem
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | Field name of matches. |
| `qValues` | `array` of [SearchFieldMatchesItem](#searchfieldmatchesitem) | List of search matches. |
Properties of `qValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchFieldMatchesItem` | [SearchFieldMatchesItem](#searchfieldmatchesitem) | |
Properties of `SearchFieldMatchesItem`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | |
| `qElemNo` | `integer` | |
| `qSearchTermsMatched` | `array of integer` | |
Properties of `qSearchTermsMatched`
**Array items:**
_Properties truncated due to depth limit._
---
### SearchGroup
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `integer` | Identifier of the search group. |
| `qGroupType` | oneOf(DatasetType \| GenericObjectsType) | |
| `qSearchTermsMatched` | `array of integer` | Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in _SearchResult.qSearchTerms_ . |
| `qTotalNumberOfItems` | `integer` | Total number of distinct items in the search group. |
| `qItems` | `array` of [SearchGroupItem](#searchgroupitem) | List of items in the search group. The group items are numbered from the value of _SearchGroupOptions.qOffset_ to the value of _SearchGroupOptions.qOffset_ \+ _SearchGroupOptions.qCount_ |
Properties of `qGroupType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `DatasetType` | `object` | DATASET_GROUP |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericObjectsType` | `object` | GENERIC_OBJECTS_GROUP |
Properties of `qSearchTermsMatched`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroupItem` | [SearchGroupItem](#searchgroupitem) | |
Properties of `SearchGroupItem`
| Name | Type | Description |
| --- | --- | --- |
| `qItemType` | oneOf(Field \| GenericObject) | |
| `qTotalNumberOfMatches` | `integer` | Total number of distinct matches in the search group item. |
| `qIdentifier` | `string` | Identifier of the item. It corresponds to: * The name of the field, if the type of the search group is data set. * The id of the generic object if the type of the search group is generic object. |
| `qItemMatches` | `array` of [SearchGroupItemMatch](#searchgroupitemmatch) | List of matches in the search group item. The group item matches are numbered from the value of _SearchGroupItemOptions.qOffset_ to the value of _SearchGroupItemOptions.qOffset_ \+ _SearchGroupItemOptions.qCount_ . |
| `qSearchTermsMatched` | `array of integer` | Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in _SearchResult.qSearchTerms_ . |
| `qMatchType` | oneOf(FieldMatchNone \| FieldMatchSubString \| FieldMatchWord \| FieldMatchExact \| FieldMatchLast) | |
Properties of `qItemType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
Properties of `qItemMatches`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qSearchTermsMatched`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMatchType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
---
### SearchGroupItem
| Name | Type | Description |
| --- | --- | --- |
| `qItemType` | oneOf(Field \| GenericObject) | |
| `qTotalNumberOfMatches` | `integer` | Total number of distinct matches in the search group item. |
| `qIdentifier` | `string` | Identifier of the item. It corresponds to: * The name of the field, if the type of the search group is data set. * The id of the generic object if the type of the search group is generic object. |
| `qItemMatches` | `array` of [SearchGroupItemMatch](#searchgroupitemmatch) | List of matches in the search group item. The group item matches are numbered from the value of _SearchGroupItemOptions.qOffset_ to the value of _SearchGroupItemOptions.qOffset_ \+ _SearchGroupItemOptions.qCount_ . |
| `qSearchTermsMatched` | `array of integer` | Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in _SearchResult.qSearchTerms_ . |
| `qMatchType` | oneOf(FieldMatchNone \| FieldMatchSubString \| FieldMatchWord \| FieldMatchExact \| FieldMatchLast) | |
Properties of `qItemType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Field` | `object` | FIELD |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericObject` | `object` | GENERIC_OBJECT |
Properties of `qItemMatches`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroupItemMatch` | [SearchGroupItemMatch](#searchgroupitemmatch) | |
Properties of `SearchGroupItemMatch`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value. |
| `qFieldSelectionMode` | oneOf(OneAndOnlyOne) | |
| `qRanges` | `array` of [SearchCharRange](#searchcharrange) | List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make. |
| `qAttributes` | `array` of [SearchAttribute](#searchattribute) | Provides detail of the match as requested by the user in _SearchObjectsOptions.qAttributes_ or _SearchCombinationOptions.qAttributes_ If the user requests _SearchObjects_ or _SearchResults_ with an empty _qAttributes_ option, the outputted _qAttributes_ is returned empty. For _SearchObjects_ requested with _qProperty_ , the _SearchGroupItemMatch.qAttributes_ return value contains _[“qProperty”, "qMetaDef/title”]_ if the match has been found in the title of the item. For dimension values, the returned _qProperty_ will be _“*”_ . For _SearchResults_ requested with _qNum_ , the _SearchGroupItemMatch.qAttributes_ return value contains _["qNum", N]_ where _N_ is the numeric value of the element or _NaN_ if the value is not numeric. For _SearchResults_ requested with _qElemNum_ , the _SearchGroupItemMatch.qAttributes_ return value contains _["qElemNum", N]_ where _N_ is the value index of the element. |
Properties of `qFieldSelectionMode`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
Properties of `qRanges`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttributes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qSearchTermsMatched`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qMatchType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchNone` | `object` | FM_NONE |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchSubString` | `object` | FM_SUBSTRING |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchWord` | `object` | FM_WORD |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchExact` | `object` | FM_EXACT |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldMatchLast` | `object` | FM_LAST |
---
### SearchGroupItemMatch
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value. |
| `qFieldSelectionMode` | oneOf(OneAndOnlyOne) | |
| `qRanges` | `array` of [SearchCharRange](#searchcharrange) | List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make. |
| `qAttributes` | `array` of [SearchAttribute](#searchattribute) | Provides detail of the match as requested by the user in _SearchObjectsOptions.qAttributes_ or _SearchCombinationOptions.qAttributes_ If the user requests _SearchObjects_ or _SearchResults_ with an empty _qAttributes_ option, the outputted _qAttributes_ is returned empty. For _SearchObjects_ requested with _qProperty_ , the _SearchGroupItemMatch.qAttributes_ return value contains _[“qProperty”, "qMetaDef/title”]_ if the match has been found in the title of the item. For dimension values, the returned _qProperty_ will be _“*”_ . For _SearchResults_ requested with _qNum_ , the _SearchGroupItemMatch.qAttributes_ return value contains _["qNum", N]_ where _N_ is the numeric value of the element or _NaN_ if the value is not numeric. For _SearchResults_ requested with _qElemNum_ , the _SearchGroupItemMatch.qAttributes_ return value contains _["qElemNum", N]_ where _N_ is the value index of the element. |
Properties of `qFieldSelectionMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `OneAndOnlyOne` | `object` | ONE_AND_ONLY_ONE |
Properties of `qRanges`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchCharRange` | [SearchCharRange](#searchcharrange) | |
Properties of `SearchCharRange`
| Name | Type | Description |
| --- | --- | --- |
| `qCharPos` | `integer` | Starting position of the match in the search result, starting from 0. |
| `qCharCount` | `integer` | Length of the match in the search result. |
| `qTerm` | `integer` | Position of the term in the list of search terms, starting from 0. |
Properties of `qAttributes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchAttribute` | [SearchAttribute](#searchattribute) | |
Properties of `SearchAttribute`
| Name | Type | Description |
| --- | --- | --- |
| `qKey` | `string` | String corresponding to _SearchObjectOptions.qAttributes_. It will be _qProperty_ for _SearchObjectOptions_. |
| `qValue` | `string` | String corresponding to _qKey_ for the current _SearchGroupItemMatch_. For example, if the match is _Make by Price_ found in the title of a generic object, _qValue_ will be _qMetaDef/title_. |
---
### SearchGroupItemOptions
| Name | Type | Description |
| --- | --- | --- |
| `qGroupItemType` | oneOf(Field \| GenericObject) | |
| `qOffset` | `integer` | Position starting from 0. The default value is 0. |
| `qCount` | `integer` | Maximum number of matches per item (in _qItemMatches[ ]_ ). The default value is -1: all values are returned. |
Properties of `qGroupItemType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Field` | `object` | FIELD |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericObject` | `object` | GENERIC_OBJECT |
---
### SearchGroupItemType
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroupItemType` | oneOf(Field \| GenericObject) | |
Properties of `SearchGroupItemType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Field` | `object` | FIELD |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericObject` | `object` | GENERIC_OBJECT |
---
### SearchGroupOptions
| Name | Type | Description |
| --- | --- | --- |
| `qGroupType` | oneOf(DatasetType \| GenericObjectsType) | |
| `qOffset` | `integer` | Position starting from 0. The default value is 0. |
| `qCount` | `integer` | Maximum number of items per group (in _qItems[ ]_ ). The default value is -1; all values are returned. |
Properties of `qGroupType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `DatasetType` | `object` | DATASET_GROUP |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericObjectsType` | `object` | GENERIC_OBJECTS_GROUP |
---
### SearchGroupType
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroupType` | oneOf(DatasetType \| GenericObjectsType) | |
Properties of `SearchGroupType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `DatasetType` | `object` | DATASET_GROUP |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `GenericObjectsType` | `object` | GENERIC_OBJECTS_GROUP |
---
### SearchMatchCombination
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `integer` | Index of the search result, starting from 0. |
| `qFieldMatches` | `array` of [SearchFieldMatch](#searchfieldmatch) | Information about the search matches. |
Properties of `qFieldMatches`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchFieldMatch` | [SearchFieldMatch](#searchfieldmatch) | |
Properties of `SearchFieldMatch`
| Name | Type | Description |
| --- | --- | --- |
| `qField` | `integer` | Position of the field in the list of fields, starting from 0. The list of fields is defined in _qResults/qFieldNames_ and contains the search associations. |
| `qValues` | `array of integer` | Positions of the matching values in the search results. The maximum number of values in this list is defined by _qMaxNbrFieldMatches_ . |
| `qTerms` | `array of integer` | Positions of the search terms, starting from 0. |
| `qNoOfMatches` | `integer` | Number of search hits in the field. The number of values in _qValues_ and the value of _qNoOfMatches_ are equal if _qMaxNbrFieldMatches_ is -1. |
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTerms`
**Array items:**
_Properties truncated due to depth limit._
---
### SearchMatchCombinations
| Name | Type | Description |
| --- | --- | --- |
| `SearchMatchCombinations` | `array` of [SearchMatchCombination](#searchmatchcombination) | |
Properties of `SearchMatchCombinations`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchMatchCombination` | [SearchMatchCombination](#searchmatchcombination) | |
Properties of `SearchMatchCombination`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `integer` | Index of the search result, starting from 0. |
| `qFieldMatches` | `array` of [SearchFieldMatch](#searchfieldmatch) | Information about the search matches. |
Properties of `qFieldMatches`
**Array items:**
_Properties truncated due to depth limit._
---
### SearchObjectOptions
| Name | Type | Description |
| --- | --- | --- |
| `qAttributes` | `array of string` | This array is either empty or contains _qProperty_ . |
| `qCharEncoding` | oneOf(Utf8 \| Utf16) | |
Properties of `qAttributes`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qCharEncoding`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `Utf8` | `object` | CHAR_ENCODING_UTF8 |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `Utf16` | `object` | CHAR_ENCODING_UTF16 |
---
### SearchPage
| Name | Type | Description |
| --- | --- | --- |
| `qOffset` | `integer` | Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0. |
| `qCount` | `integer` | Number of search groups to return (in _qSearchGroupArray_ ). |
| `qMaxNbrFieldMatches` | `integer` | Maximum number of matching values to return per search result. The default value is -1; all values are returned. This property is to be used with the _SearchAssociations method_. |
| `qGroupOptions` | `array` of [SearchGroupOptions](#searchgroupoptions) | Options of the search groups. If this property is not set, all values are returned. This property is to be used with the _SearchResults method_ or the _SearchObjects method_. |
| `qGroupItemOptions` | `array` of [SearchGroupItemOptions](#searchgroupitemoptions) | Options of the search group items. If this property is not set, all values are returned. This property is to be used with the _SearchResults method_ or the _SearchObjects method_. |
Properties of `qGroupOptions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroupOptions` | [SearchGroupOptions](#searchgroupoptions) | |
Properties of `SearchGroupOptions`
| Name | Type | Description |
| --- | --- | --- |
| `qGroupType` | oneOf(DatasetType \| GenericObjectsType) | |
| `qOffset` | `integer` | Position starting from 0. The default value is 0. |
| `qCount` | `integer` | Maximum number of items per group (in _qItems[ ]_ ). The default value is -1; all values are returned. |
Properties of `qGroupType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
Properties of `qGroupItemOptions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroupItemOptions` | [SearchGroupItemOptions](#searchgroupitemoptions) | |
Properties of `SearchGroupItemOptions`
| Name | Type | Description |
| --- | --- | --- |
| `qGroupItemType` | oneOf(Field \| GenericObject) | |
| `qOffset` | `integer` | Position starting from 0. The default value is 0. |
| `qCount` | `integer` | Maximum number of matches per item (in _qItemMatches[ ]_ ). The default value is -1: all values are returned. |
Properties of `qGroupItemType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
---
### SearchResult
| Name | Type | Description |
| --- | --- | --- |
| `qSearchTerms` | `array of string` | List of the search terms. |
| `qTotalNumberOfGroups` | `integer` | Total number of groups. |
| `qSearchGroupArray` | `array` of [SearchGroup](#searchgroup) | List of search groups. The groups are numbered from the value of _SearchPage.qOffset_ to the value of _SearchPage.qOffset + SearchPage.qCount_ . |
Properties of `qSearchTerms`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qSearchGroupArray`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchGroup` | [SearchGroup](#searchgroup) | |
Properties of `SearchGroup`
| Name | Type | Description |
| --- | --- | --- |
| `qId` | `integer` | Identifier of the search group. |
| `qGroupType` | oneOf(DatasetType \| GenericObjectsType) | |
| `qSearchTermsMatched` | `array of integer` | Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in _SearchResult.qSearchTerms_ . |
| `qTotalNumberOfItems` | `integer` | Total number of distinct items in the search group. |
| `qItems` | `array` of [SearchGroupItem](#searchgroupitem) | List of items in the search group. The group items are numbered from the value of _SearchGroupOptions.qOffset_ to the value of _SearchGroupOptions.qOffset_ \+ _SearchGroupOptions.qCount_ |
Properties of `qGroupType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
Properties of `qSearchTermsMatched`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qItems`
**Array items:**
_Properties truncated due to depth limit._
---
### SearchSuggestItem
| Name | Type | Description |
| --- | --- | --- |
| `qValue` | `string` | Value of the suggestion. |
| `qTerm` | `integer` | Index of the suggestion value. The indexing starts from 0 and from the left. |
---
### SearchSuggestionResult
| Name | Type | Description |
| --- | --- | --- |
| `qSuggestions` | `array` of [SearchSuggestItem](#searchsuggestitem) | List of suggestions. |
| `qFieldNames` | `array of string` | List of field names that contain search hits. |
Properties of `qSuggestions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchSuggestItem` | [SearchSuggestItem](#searchsuggestitem) | |
Properties of `SearchSuggestItem`
| Name | Type | Description |
| --- | --- | --- |
| `qValue` | `string` | Value of the suggestion. |
| `qTerm` | `integer` | Index of the suggestion value. The indexing starts from 0 and from the left. |
Properties of `qFieldNames`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### SearchTermResult
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text of the associated value. |
| `qElemNumber` | `integer` | Element number of the associated value. |
| `qRanges` | `array` of [SearchCharRange](#searchcharrange) | List of ranges. For example, if the user searches the term _read_ and the associative value is _Reading_ , then the corresponding range would be _Read_ in _Reading_ . |
Properties of `qRanges`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchCharRange` | [SearchCharRange](#searchcharrange) | |
Properties of `SearchCharRange`
| Name | Type | Description |
| --- | --- | --- |
| `qCharPos` | `integer` | Starting position of the match in the search result, starting from 0. |
| `qCharCount` | `integer` | Length of the match in the search result. |
| `qTerm` | `integer` | Position of the term in the list of search terms, starting from 0. |
---
### SearchValueOptions
| Name | Type | Description |
| --- | --- | --- |
| `qSearchFields` | `array of string` | List of the search fields. If empty, the search is performed in all fields of the app. |
Properties of `qSearchFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### SearchValuePage
| Name | Type | Description |
| --- | --- | --- |
| `qOffset` | `integer` | Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0. |
| `qCount` | `integer` | Number of search fields to return |
| `qMaxNbrFieldMatches` | `integer` | Maximum number of matching values to return per search result. |
---
### SearchValueResult
| Name | Type | Description |
| --- | --- | --- |
| `qSearchTerms` | `array of string` | List of the search terms. |
| `qFieldMatches` | `array` of [SearchFieldValueItem](#searchfieldvalueitem) | List of search groups. The groups are numbered from the value of _SearchPage.qOffset_ to the value of _SearchPage.qOffset + SearchPage.qCount_ . |
Properties of `qSearchTerms`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qFieldMatches`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `SearchFieldValueItem` | [SearchFieldValueItem](#searchfieldvalueitem) | |
Properties of `SearchFieldValueItem`
| Name | Type | Description |
| --- | --- | --- |
| `qFieldName` | `string` | Field name of matches. |
| `qValues` | `array` of [SearchFieldMatchesItem](#searchfieldmatchesitem) | List of search matches. |
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
---
### SelectInfo
| Name | Type | Description |
| --- | --- | --- |
| `qTextSearch` | `string` | Text search string. Everything that matches the text is selected. This parameter is optional. |
| `qRangeLo` | `number` | Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null. |
| `qRangeHi` | `number` | Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null. |
| `qNumberFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qRangeInfo` | `array` of [RangeSelectInfo](#rangeselectinfo) | This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections. |
| `qSoftLock` | `boolean` | Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
| `qContinuousRangeInfo` | `array` of [Range](#range) | List of information about ranges for selections. |
| `qSelectFieldSearch` | `boolean` | This parameter is true if the TextSearch is a result of a Select Field operation. |
Properties of `qNumberFormat`
| Name | Type | Description |
| --- | --- | --- |
| `qType` | oneOf(U \| A \| I \| R \| F \| M \| D \| T \| TS \| IV) | |
| `qnDec` | `integer` | Number of decimals. Default is 10. |
| `qUseThou` | `integer` | Defines whether or not a thousands separator must be used. Default is 0. |
| `qFmt` | `string` | Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. |
| `qDec` | `string` | Defines the decimal separator. Example: **.** |
| `qThou` | `string` | Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** |
Properties of `qType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `U` | `object` | UNKNOWN |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ASCII |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `I` | `object` | INTEGER |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `R` | `object` | REAL |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `F` | `object` | FIX |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `M` | `object` | MONEY |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DATE |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `T` | `object` | TIME |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `TS` | `object` | TIMESTAMP |
**Option 10:**
| Name | Type | Description |
| --- | --- | --- |
| `IV` | `object` | INTERVAL |
Properties of `qRangeInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `RangeSelectInfo` | [RangeSelectInfo](#rangeselectinfo) | |
Properties of `RangeSelectInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qRangeLo` | `number` | Lowest value in the range. |
| `qRangeHi` | `number` | Highest value in the range. |
| `qMeasure` | `string` | Label of the measure. |
Properties of `qContinuousRangeInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `Range` | [Range](#range) | |
Properties of `Range`
| Name | Type | Description |
| --- | --- | --- |
| `qMin` | `number` | Lowest value in the range |
| `qMax` | `number` | Highest value in the range |
| `qMinInclEq` | `boolean` | If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 1 is included in the range of selections. |
| `qMaxInclEq` | `boolean` | If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If _qMinInclEq_ is set to true it means that 10 is included in the range of selections. |
---
### SelectionObject
Indicates which selections are currently applied. It gives the current selections. Is the layout for _SelectionObjectDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qBackCount` | `integer` | Number of steps back. |
| `qForwardCount` | `integer` | Number of steps forward. |
| `qSelections` | `array` of [NxCurrentSelectionItem](#nxcurrentselectionitem) | Lists the fields that are selected. |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
Properties of `qSelections`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxCurrentSelectionItem` | [NxCurrentSelectionItem](#nxcurrentselectionitem) | |
Properties of `NxCurrentSelectionItem`
| Name | Type | Description |
| --- | --- | --- |
| `qTotal` | `integer` | Number of values in the field. |
| `qIsNum` | `boolean` | This parameter is displayed if its value is true. Is set to true if the field is a numeric. This parameter is optional. |
| `qField` | `string` | Name of the field that is selected. |
| `qLocked` | `boolean` | This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional. |
| `qOneAndOnlyOne` | `boolean` | This parameter is displayed if its value is true. Property that is set to a field. Is set to true if the field cannot be unselected. This parameter is optional. |
| `qTextSearch` | `string` | Text that was used for the search. This parameter is filled when searching for a value and selecting it. This parameter is optional. |
| `qSelectedCount` | `integer` | Number of values that are selected. |
| `qSelected` | `string` | Values that are selected. |
| `qRangeInfo` | `array` of [RangeSelectInfo](#rangeselectinfo) | Information about the range of selected values. Is empty if there is no range of selected values. |
| `qSortIndex` | `integer` | Sort index of the field. Indexing starts from 0. |
| `qStateCounts` | [NxStateCounts](#nxstatecounts) | |
| `qSelectedFieldSelectionInfo` | `array` of [NxFieldSelectionInfo](#nxfieldselectioninfo) | Information about the fields that are selected. |
| `qNotSelectedFieldSelectionInfo` | `array` of [NxFieldSelectionInfo](#nxfieldselectioninfo) | Information about the fields that are not selected. |
| `qSelectionThreshold` | `integer` | Maximum values to show in the current selections. The default value is 6. |
| `qReadableName` | `string` | Label that, if defined, is displayed in current selections instead of the actual expression. ReadableName is only used with field-on-the-fly. |
| `qIsHidden` | `boolean` | Optional parameter. Indicates if the selection is to be hidden in the Selections bar. Is set to true if the current selection is hidden. |
| `qDimensionReferences` | `array` of [DimensionReference](#dimensionreference) | List of dimensions in the app that refer to the data model field of an NxCurrentSelectionItem. |
Properties of `qRangeInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qStateCounts`
_Properties truncated due to depth limit._
Properties of `qSelectedFieldSelectionInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qNotSelectedFieldSelectionInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qDimensionReferences`
**Array items:**
_Properties truncated due to depth limit._
---
### SelectionObjectDef
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": {}
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
---
### Size
| Name | Type | Description |
| --- | --- | --- |
| `qcx` | `integer` | Number of pixels on the _x_ axis. |
| `qcy` | `integer` | Number of pixels on the _y_ axis. |
---
### SortCriteria
| Name | Type | Description |
| --- | --- | --- |
| `qSortByState` | `integer` | Sorts the field values according to their logical state (selected, optional, alternative or excluded). |
| `qSortByFrequency` | `integer` | Sorts the field values by frequency (number of occurrences in the field). |
| `qSortByNumeric` | `integer` | Sorts the field values by numeric value. |
| `qSortByAscii` | `integer` | Sorts the field by alphabetical order. |
| `qSortByLoadOrder` | `integer` | Sorts the field values by the initial load order. |
| `qSortByExpression` | `integer` | Sorts the field by expression. |
| `qExpression` | [ValueExpr](#valueexpr) | |
| `qSortByGreyness` | `integer` | |
Properties of `qExpression`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
---
### SourceKeyRecord
| Name | Type | Description |
| --- | --- | --- |
| `qKeyFields` | `array of string` | Name of the key field. |
| `qTables` | `array of string` | Table the key belongs to. |
Properties of `qKeyFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### StateEnumType
| Name | Type | Description |
| --- | --- | --- |
| `StateEnumType` | oneOf(L \| S \| O \| D \| A \| X \| XS \| XL \| NSTATES) | |
Properties of `StateEnumType`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `L` | `object` | LOCKED |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `S` | `object` | SELECTED |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `O` | `object` | OPTION |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `D` | `object` | DESELECTED |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `A` | `object` | ALTERNATIVE |
**Option 6:**
| Name | Type | Description |
| --- | --- | --- |
| `X` | `object` | EXCLUDED |
**Option 7:**
| Name | Type | Description |
| --- | --- | --- |
| `XS` | `object` | EXCL_SELECTED |
**Option 8:**
| Name | Type | Description |
| --- | --- | --- |
| `XL` | `object` | EXCL_LOCKED |
**Option 9:**
| Name | Type | Description |
| --- | --- | --- |
| `NSTATES` | `object` | |
---
### StateFieldValues
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the state. |
| `qFieldValues` | `array` of [FieldValue](#fieldvalue) | The field values associated with the state. |
Properties of `qFieldValues`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldValue` | [FieldValue](#fieldvalue) | |
Properties of `FieldValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
---
### StaticContentList
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [StaticContentListItem](#staticcontentlistitem) | Information about the list of content files. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `StaticContentListItem` | [StaticContentListItem](#staticcontentlistitem) | In addition, this structure can return dynamic properties.
|
Properties of `StaticContentListItem`
| Name | Type | Description |
| --- | --- | --- |
| `qUrlDef` | `string` | Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located: * In the _/content/ <content library name>/_ folder are part of a global content library. * In the _/appcontent/_ folder are part of the app specific library. The content files are never embedded in the _qvf_ file. In Qlik Sense Desktop, content files located: * In the _/content/default/_ folder are outside the qvf file. * In the _/media/ folder_ are embedded in the qvf file. |
| `qUrl` | `string` | Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located: * In the _/content/ <content library name>/_ folder are part of a global content library. * In the _/appcontent/_ folder are part of the app specific library. The content files are never embedded in the _qvf_ file. In Qlik Sense Desktop, content files located: * In the _/content/default/_ folder are outside the qvf file. * In the _/media/ folder_ are embedded in the qvf file. |
---
### StaticContentListItem
In addition, this structure can return dynamic properties.
| Name | Type | Description |
| --- | --- | --- |
| `qUrlDef` | `string` | Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located: * In the _/content/ <content library name>/_ folder are part of a global content library. * In the _/appcontent/_ folder are part of the app specific library. The content files are never embedded in the _qvf_ file. In Qlik Sense Desktop, content files located: * In the _/content/default/_ folder are outside the qvf file. * In the _/media/ folder_ are embedded in the qvf file. |
| `qUrl` | `string` | Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located: * In the _/content/ <content library name>/_ folder are part of a global content library. * In the _/appcontent/_ folder are part of the app specific library. The content files are never embedded in the _qvf_ file. In Qlik Sense Desktop, content files located: * In the _/content/default/_ folder are outside the qvf file. * In the _/media/ folder_ are embedded in the qvf file. |
---
### StaticContentUrl
In addition, this structure can return dynamic properties.
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
---
### StaticContentUrlDef
In addition, this structure can contain dynamic properties.
| Name | Type | Description |
| --- | --- | --- |
| `qUrl` | `string` | Relative path of the thumbnail. |
---
### StringExpr
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
---
### StringExpression
**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.
| Name | Type | Description |
| --- | --- | --- |
| `qExpr` | `string` | |
---
### SymbolFrequency
| Name | Type | Description |
| --- | --- | --- |
| `qSymbol` | [SymbolValue](#symbolvalue) | |
| `qFrequency` | `integer` | Frequency of the above symbol in the field |
Properties of `qSymbol`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | String value of the symbol. This parameter is optional and present only if Symbol is a string. |
| `qNumber` | `number` | Numeric value of the symbol. NaN otherwise. |
---
### SymbolValue
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | String value of the symbol. This parameter is optional and present only if Symbol is a string. |
| `qNumber` | `number` | Numeric value of the symbol. NaN otherwise. |
---
### TableProfilingData
| Name | Type | Description |
| --- | --- | --- |
| `qNoOfRows` | `integer` | Number of rows in the table. |
| `qFieldProfiling` | `array` of [FieldInTableProfilingData](#fieldintableprofilingdata) | Field values profiling info |
Properties of `qFieldProfiling`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldInTableProfilingData` | [FieldInTableProfilingData](#fieldintableprofilingdata) | |
Properties of `FieldInTableProfilingData`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qFieldTags` | `array of string` | List of tags related to the field. |
| `qNumberFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qDistinctValues` | `integer` | Number of distinct values |
| `qDistinctNumericValues` | `integer` | Number of distinct numeric values |
| `qDistinctTextValues` | `integer` | Number of distinct text values |
| `qNumericValues` | `integer` | Number of numeric values |
| `qNullValues` | `integer` | Number of null values |
| `qTextValues` | `integer` | Number of textual values |
| `qNegValues` | `integer` | Number of negative values |
| `qPosValues` | `integer` | Number of positive values |
| `qZeroValues` | `integer` | Number of zero values for numerical values |
| `qSum` | `number` | Sum of all numerical values. NaN otherwise. |
| `qSum2` | `number` | Squared sum of all numerical values. NaN otherwise. |
| `qAverage` | `number` | Average of all numerical values. NaN otherwise. |
| `qMedian` | `number` | Median of all numerical values. NaN otherwise. |
| `qStd` | `number` | Standard deviation of numerical values. NaN otherwise. |
| `qMin` | `number` | Minimum value of numerical values. NaN otherwise. |
| `qMax` | `number` | Maximum value of numerical values. NaN otherwise. |
| `qSkewness` | `number` | Skewness of the numerical values. NaN otherwise. |
| `qKurtosis` | `number` | Kurtosis of the numerical values. NaN otherwise. |
| `qFractiles` | `array of number` | The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise. |
| `qEmptyStrings` | `integer` | Number of empty strings |
| `qMaxStringLen` | `integer` | Maximum string length of textual values. 0 otherwise. |
| `qMinStringLen` | `integer` | Minimum string length of textual values. 0 otherwise. |
| `qSumStringLen` | `integer` | Sum of all characters in strings in the field |
| `qAvgStringLen` | `number` | Average string length of textual values. 0 otherwise. |
| `qFirstSorted` | `string` | For textual values the first sorted string. |
| `qLastSorted` | `string` | For textual values the last sorted string. |
| `qMostFrequent` | `array` of [SymbolFrequency](#symbolfrequency) | Three most frequent values and their frequencies |
| `qFrequencyDistribution` | [FrequencyDistributionData](#frequencydistributiondata) | |
| `qDataEvenness` | `number` | Data evenness aka Shannon's entropy normalized to [0,1] |
Properties of `qFieldTags`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qNumberFormat`
_Properties truncated due to depth limit._
Properties of `qFractiles`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMostFrequent`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qFrequencyDistribution`
_Properties truncated due to depth limit._
---
### TableRecord
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the table. |
| `qLoose` | `boolean` | This property is set to true if the table is loose. |
| `qNoOfRows` | `integer` | Number of rows in the table. |
| `qFields` | `array` of [FieldInTableData](#fieldintabledata) | Information about the fields in the table. |
| `qPos` | [Point](#point) | |
| `qComment` | `string` | Comment related to the table. |
| `qIsDirectDiscovery` | `boolean` | If set to true, Direct Discovery is used. Direct Discovery fields are not loaded into memory and remain in the external database. |
| `qIsSynthetic` | `boolean` | This property is set to true if the table contains a synthetic key. |
| `qTableTags` | `array of string` | List of tags related to the table. |
| `qProfilingData` | [TableProfilingData](#tableprofilingdata) | |
Properties of `qFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldInTableData` | [FieldInTableData](#fieldintabledata) | |
Properties of `FieldInTableData`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the field. |
| `qOriginalFields` | `array of string` | Is shown for fixed records. _qOriginalFieldName_ and _qName_ are identical if no field names are used in the file. _qOriginalFieldName_ differs from _qName_ if embedded file names are used in the file. |
| `qPresent` | `boolean` | |
| `qHasNull` | `boolean` | This property is set to true if the field contains some Null values. |
| `qHasWild` | `boolean` | |
| `qHasDuplicates` | `boolean` | This property is set to true if the field contains some duplicate values. |
| `qIsSynthetic` | `boolean` | This property is set to true if the field contains a synthetic key. |
| `qInformationDensity` | `number` | Number of records that have values (for example, not NULL) in the field as compared to the total number of records in the table. |
| `qnNonNulls` | `integer` | Number of values that are non Null. |
| `qnRows` | `integer` | Number of rows in the field. |
| `qSubsetRatio` | `number` | Number of distinct values in the field (in the current table) as compared to the total number of distinct values of this field (in all tables). |
| `qnTotalDistinctValues` | `integer` | Number of distinct values in the field. |
| `qnPresentDistinctValues` | `integer` | |
| `qKeyType` | oneOf(NOT_KEY \| ANY_KEY \| PRIMARY_KEY \| PERFECT_KEY) | |
| `qComment` | `string` | Comment related to the field. |
| `qTags` | `array of string` | List of tags related to the field. |
| `qDerivedFields` | `array` of [DerivedFieldsInTableData](#derivedfieldsintabledata) | List of the derived fields. |
| `qIsFieldOnTheFly` | `boolean` | |
| `qReadableName` | `string` | |
Properties of `qOriginalFields`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qKeyType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qDerivedFields`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | x-coordinate in pixels. The origin is the top left of the screen. |
| `qy` | `integer` | y-coordinate in pixels. The origin is the top left of the screen. |
Properties of `qTableTags`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
Properties of `qProfilingData`
| Name | Type | Description |
| --- | --- | --- |
| `qNoOfRows` | `integer` | Number of rows in the table. |
| `qFieldProfiling` | `array` of [FieldInTableProfilingData](#fieldintableprofilingdata) | Field values profiling info |
Properties of `qFieldProfiling`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldInTableProfilingData` | [FieldInTableProfilingData](#fieldintableprofilingdata) | |
Properties of `FieldInTableProfilingData`
_Properties truncated due to depth limit._
---
### TableRow
| Name | Type | Description |
| --- | --- | --- |
| `qValue` | `array` of [FieldValue](#fieldvalue) | Array of field values. |
Properties of `qValue`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `FieldValue` | [FieldValue](#fieldvalue) | |
Properties of `FieldValue`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | Text related to the field value. This parameter is optional. |
| `qIsNumeric` | `boolean` | Is set to true if the value is a numeric. This parameter is optional. Default is false. |
| `qNumber` | `number` | Numeric value of the field. This parameter is displayed if _qIsNumeric_ is set to true. This parameter is optional. |
---
### TableViewBroomPointSaveInfo
| Name | Type | Description |
| --- | --- | --- |
| `qPos` | [Point](#point) | |
| `qTable` | `string` | Name of the table. |
| `qFields` | `array of string` | List of fields in the table. |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | x-coordinate in pixels. The origin is the top left of the screen. |
| `qy` | `integer` | y-coordinate in pixels. The origin is the top left of the screen. |
Properties of `qFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### TableViewConnectionPointSaveInfo
| Name | Type | Description |
| --- | --- | --- |
| `qPos` | [Point](#point) | |
| `qFields` | `array of string` | List of the fields in the table. |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | x-coordinate in pixels. The origin is the top left of the screen. |
| `qy` | `integer` | y-coordinate in pixels. The origin is the top left of the screen. |
Properties of `qFields`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `string` | |
---
### TableViewCtlSaveInfo
| Name | Type | Description |
| --- | --- | --- |
| `qInternalView` | [TableViewSaveInfo](#tableviewsaveinfo) | |
| `qSourceView` | [TableViewSaveInfo](#tableviewsaveinfo) | |
Properties of `qInternalView`
| Name | Type | Description |
| --- | --- | --- |
| `qTables` | `array` of [TableViewTableWinSaveInfo](#tableviewtablewinsaveinfo) | List of the tables in the database model viewer. |
| `qBroomPoints` | `array` of [TableViewBroomPointSaveInfo](#tableviewbroompointsaveinfo) | List of the broom points in the database model viewer. Not used in Qlik Sense. |
| `qConnectionPoints` | `array` of [TableViewConnectionPointSaveInfo](#tableviewconnectionpointsaveinfo) | List of connection points in the database model viewer. Not used in Qlik Sense. |
| `qZoomFactor` | `number` | Zoom factor in the database model viewer. The default value is 1.0. |
Properties of `qTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewTableWinSaveInfo` | [TableViewTableWinSaveInfo](#tableviewtablewinsaveinfo) | |
Properties of `TableViewTableWinSaveInfo`
_Properties truncated due to depth limit._
Properties of `qBroomPoints`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewBroomPointSaveInfo` | [TableViewBroomPointSaveInfo](#tableviewbroompointsaveinfo) | |
Properties of `TableViewBroomPointSaveInfo`
_Properties truncated due to depth limit._
Properties of `qConnectionPoints`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewConnectionPointSaveInfo` | [TableViewConnectionPointSaveInfo](#tableviewconnectionpointsaveinfo) | |
Properties of `TableViewConnectionPointSaveInfo`
_Properties truncated due to depth limit._
Properties of `qSourceView`
| Name | Type | Description |
| --- | --- | --- |
| `qTables` | `array` of [TableViewTableWinSaveInfo](#tableviewtablewinsaveinfo) | List of the tables in the database model viewer. |
| `qBroomPoints` | `array` of [TableViewBroomPointSaveInfo](#tableviewbroompointsaveinfo) | List of the broom points in the database model viewer. Not used in Qlik Sense. |
| `qConnectionPoints` | `array` of [TableViewConnectionPointSaveInfo](#tableviewconnectionpointsaveinfo) | List of connection points in the database model viewer. Not used in Qlik Sense. |
| `qZoomFactor` | `number` | Zoom factor in the database model viewer. The default value is 1.0. |
Properties of `qTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewTableWinSaveInfo` | [TableViewTableWinSaveInfo](#tableviewtablewinsaveinfo) | |
Properties of `TableViewTableWinSaveInfo`
_Properties truncated due to depth limit._
Properties of `qBroomPoints`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewBroomPointSaveInfo` | [TableViewBroomPointSaveInfo](#tableviewbroompointsaveinfo) | |
Properties of `TableViewBroomPointSaveInfo`
_Properties truncated due to depth limit._
Properties of `qConnectionPoints`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewConnectionPointSaveInfo` | [TableViewConnectionPointSaveInfo](#tableviewconnectionpointsaveinfo) | |
Properties of `TableViewConnectionPointSaveInfo`
_Properties truncated due to depth limit._
---
### TableViewDlgSaveInfo
| Name | Type | Description |
| --- | --- | --- |
| `qPos` | [Rect](#rect) | |
| `qCtlInfo` | [TableViewCtlSaveInfo](#tableviewctlsaveinfo) | |
| `qMode` | `integer` | View mode to display when opening Qlik Sense data model viewer. One of: * 0 for internal view mode. * 1 for source view mode. |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
Properties of `qCtlInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qInternalView` | [TableViewSaveInfo](#tableviewsaveinfo) | |
| `qSourceView` | [TableViewSaveInfo](#tableviewsaveinfo) | |
Properties of `qInternalView`
| Name | Type | Description |
| --- | --- | --- |
| `qTables` | `array` of [TableViewTableWinSaveInfo](#tableviewtablewinsaveinfo) | List of the tables in the database model viewer. |
| `qBroomPoints` | `array` of [TableViewBroomPointSaveInfo](#tableviewbroompointsaveinfo) | List of the broom points in the database model viewer. Not used in Qlik Sense. |
| `qConnectionPoints` | `array` of [TableViewConnectionPointSaveInfo](#tableviewconnectionpointsaveinfo) | List of connection points in the database model viewer. Not used in Qlik Sense. |
| `qZoomFactor` | `number` | Zoom factor in the database model viewer. The default value is 1.0. |
Properties of `qTables`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qBroomPoints`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qConnectionPoints`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qSourceView`
| Name | Type | Description |
| --- | --- | --- |
| `qTables` | `array` of [TableViewTableWinSaveInfo](#tableviewtablewinsaveinfo) | List of the tables in the database model viewer. |
| `qBroomPoints` | `array` of [TableViewBroomPointSaveInfo](#tableviewbroompointsaveinfo) | List of the broom points in the database model viewer. Not used in Qlik Sense. |
| `qConnectionPoints` | `array` of [TableViewConnectionPointSaveInfo](#tableviewconnectionpointsaveinfo) | List of connection points in the database model viewer. Not used in Qlik Sense. |
| `qZoomFactor` | `number` | Zoom factor in the database model viewer. The default value is 1.0. |
Properties of `qTables`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qBroomPoints`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qConnectionPoints`
**Array items:**
_Properties truncated due to depth limit._
---
### TableViewSaveInfo
| Name | Type | Description |
| --- | --- | --- |
| `qTables` | `array` of [TableViewTableWinSaveInfo](#tableviewtablewinsaveinfo) | List of the tables in the database model viewer. |
| `qBroomPoints` | `array` of [TableViewBroomPointSaveInfo](#tableviewbroompointsaveinfo) | List of the broom points in the database model viewer. Not used in Qlik Sense. |
| `qConnectionPoints` | `array` of [TableViewConnectionPointSaveInfo](#tableviewconnectionpointsaveinfo) | List of connection points in the database model viewer. Not used in Qlik Sense. |
| `qZoomFactor` | `number` | Zoom factor in the database model viewer. The default value is 1.0. |
Properties of `qTables`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewTableWinSaveInfo` | [TableViewTableWinSaveInfo](#tableviewtablewinsaveinfo) | |
Properties of `TableViewTableWinSaveInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qPos` | [Rect](#rect) | |
| `qCaption` | `string` | Table name. |
Properties of `qPos`
_Properties truncated due to depth limit._
Properties of `qBroomPoints`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewBroomPointSaveInfo` | [TableViewBroomPointSaveInfo](#tableviewbroompointsaveinfo) | |
Properties of `TableViewBroomPointSaveInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qPos` | [Point](#point) | |
| `qTable` | `string` | Name of the table. |
| `qFields` | `array of string` | List of fields in the table. |
Properties of `qPos`
_Properties truncated due to depth limit._
Properties of `qFields`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qConnectionPoints`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `TableViewConnectionPointSaveInfo` | [TableViewConnectionPointSaveInfo](#tableviewconnectionpointsaveinfo) | |
Properties of `TableViewConnectionPointSaveInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qPos` | [Point](#point) | |
| `qFields` | `array of string` | List of the fields in the table. |
Properties of `qPos`
_Properties truncated due to depth limit._
Properties of `qFields`
**Array items:**
_Properties truncated due to depth limit._
---
### TableViewTableWinSaveInfo
| Name | Type | Description |
| --- | --- | --- |
| `qPos` | [Rect](#rect) | |
| `qCaption` | `string` | Table name. |
Properties of `qPos`
| Name | Type | Description |
| --- | --- | --- |
| `qLeft` | `integer` | Position from the left. Corresponds to the first column. |
| `qTop` | `integer` | Position from the top. Corresponds to the first row. |
| `qWidth` | `integer` | Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
| `qHeight` | `integer` | Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ). |
---
### TextMacro
| Name | Type | Description |
| --- | --- | --- |
| `qTag` | `string` | Name of the variable. |
| `qRefSeqNo` | `integer` | Order in which the variable was referenced during the script execution. The same number sequence is used for both _qRefSeqNo_ and _qSetSeqNo_ . |
| `qSetSeqNo` | `integer` | Order in which the variable was updated during the script execution. The same number sequence is used for both _qRefSeqNo_ and _qSetSeqNo_ . |
| `qDisplayString` | `string` | Variable value. |
| `qIsSystem` | `boolean` | Is set to true if the variable is a system variable. |
| `qIsReserved` | `boolean` | Is set to true if the variable is a reserved variable. |
---
### TotalMode
| Name | Type | Description |
| --- | --- | --- |
| `TotalMode` | oneOf(TOTAL_OFF \| TOTAL_EXPR) | |
Properties of `TotalMode`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_OFF` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `TOTAL_EXPR` | `object` | |
---
### TransformAppParameters
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | The name (title) of the application |
| `qSpaceId` | `string` | ID of the space where the app is to be created. Empty value implies Personal space |
| `qScriptParameterPrefix` | `string` | Prefix to be used on inserted ScriptParameters, only applicable for template apps |
---
### TransformAppResult
| Name | Type | Description |
| --- | --- | --- |
| `qAppId` | `string` | ID of created App |
---
### TreeData
Renders the properties of a TreeData object. Is the layout for TreeDataDef.
For more information about the definition of TreeData, see _Generic object_.
To retrieve data from the TreeData object, use the method called GetHyperCubeTreeData.
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
| `qNodesOnDim` | `array of integer` | The total number of nodes on each dimension. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qDimensionInfo` | `array` of [NxTreeDimensionInfo](#nxtreedimensioninfo) | Information on the dimension. |
| `qEffectiveInterColumnSortOrder` | `array of integer` | Defines the order of the dimenion levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. |
| `qHasOtherValues` | `boolean` | True if other row exists. |
| `qTitle` | `string` | Title of the TreeData object, for example the title of a chart. |
| `qLastExpandedPos` | [NxCellPosition](#nxcellposition) | |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qTreeDataPages` | `array` of [NxTreeNode](#nxtreenode) | Set of data. Is empty if nothing has been defined in **qInitialDataFetch** in _TreeDataDef_. |
| `qMeasureInfo` | `array` of [NxMeasureInfo](#nxmeasureinfo) | Information on the measures calculated on the whole tree. |
Properties of `qNodesOnDim`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qError`
| Name | Type | Description |
| --- | --- | --- |
| `qErrorCode` | `integer` | Error code. This parameter is always displayed in case of error. |
| `qContext` | `string` | Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional. |
| `qExtendedMessage` | `string` | Internal information from the server. This parameter is optional. |
Properties of `qDimensionInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTreeDimensionInfo` | [NxTreeDimensionInfo](#nxtreedimensioninfo) | |
Properties of `NxTreeDimensionInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qLocked` | `boolean` | Is set to true if the field is locked. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qGroupFallbackTitles` | `array of string` | Array of dimension labels. Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group). |
| `qGroupPos` | `integer` | Index of the dimension that is currently in use. _qGroupPos_ is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups. |
| `qStateCounts` | [NxStateCounts](#nxstatecounts) | |
| `qTags` | `array of string` | Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qDimensionType` | oneOf(D \| N \| T) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qGrouping` | oneOf(N \| H \| C) | |
| `qIsSemantic` | `boolean` | If set to true, it means that the field is a semantic. |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's definition. |
| `qGroupFieldDefs` | `array of string` | Array of field names. |
| `qMin` | `number` | Minimum value. |
| `qMax` | `number` | Maximum value. |
| `qContinuousAxes` | `boolean` | Is continuous axis used. |
| `qIsCyclic` | `boolean` | Is a cyclic dimension used. |
| `qDerivedField` | `boolean` | Is derived field is used as a dimension. |
| `qMeasureInfo` | `array` of [NxMeasureInfo](#nxmeasureinfo) | A List of measures to be calculated on this TreeDimension. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | List of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | List of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qIsCalculated` | `boolean` | True if this is a calculated dimension. |
| `qIsOneAndOnlyOne` | `boolean` | If set to true, it means that the field always has one and only one selected value. |
| `qCardinalities` | [NxCardinalities](#nxcardinalities) | |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qEffectiveDimensionName` | `string` | The expanded and stripped dimension name used internally in engine. |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qGroupFallbackTitles`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qStateCounts`
_Properties truncated due to depth limit._
Properties of `qTags`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qDimensionType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qGrouping`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qGroupFieldDefs`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMeasureInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExprInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCardinalities`
_Properties truncated due to depth limit._
Properties of `qEffectiveInterColumnSortOrder`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qLastExpandedPos`
| Name | Type | Description |
| --- | --- | --- |
| `qx` | `integer` | Position of the cell on the x-axis. |
| `qy` | `integer` | Position of the cell on the y-axis. |
Properties of `qTreeDataPages`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTreeNode` | [NxTreeNode](#nxtreenode) | Represents a dimension in the tree. |
Properties of `NxTreeNode`
| Name | Type | Description |
| --- | --- | --- |
| `qText` | `string` | The text version of the value, if available. |
| `qValue` | `number` | Value of the cell. Is set to _NaN_ , if the value is not a number. |
| `qElemNo` | `integer` | Element number. |
| `qGroupPos` | `integer` | The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched. |
| `qGroupSize` | `integer` | Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched. |
| `qRow` | `integer` | Row index in the data matrix. The indexing starts from 0. |
| `qType` | oneOf(V \| E \| N \| T \| O \| A \| P \| R \| U \| G) | |
| `qValues` | `array` of [NxTreeValue](#nxtreevalue) | The measures for this node. |
| `qNodes` | `array` of [NxTreeNode](#nxtreenode) | The children of this node in the fetched tree structure. |
| `qAttrExps` | [NxAttributeExpressionValues](#nxattributeexpressionvalues) | |
| `qAttrDims` | [NxAttributeDimValues](#nxattributedimvalues) | |
| `qMaxPos` | `array of number` | Total of the positive values in the current group of cells. |
| `qMinNeg` | `array of number` | Total of the negative values in the current group of cells. |
| `qCanExpand` | `boolean` | If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false. |
| `qCanCollapse` | `boolean` | If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false. |
| `qState` | oneOf(L \| S \| O \| D \| A \| X \| XS \| XL \| NSTATES) | |
| `qTreePath` | `array of integer` | The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty. |
Properties of `qType`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
**Option 10:**
_Properties truncated due to depth limit._
Properties of `qValues`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrExps`
_Properties truncated due to depth limit._
Properties of `qAttrDims`
_Properties truncated due to depth limit._
Properties of `qMaxPos`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMinNeg`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qState`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
**Option 4:**
_Properties truncated due to depth limit._
**Option 5:**
_Properties truncated due to depth limit._
**Option 6:**
_Properties truncated due to depth limit._
**Option 7:**
_Properties truncated due to depth limit._
**Option 8:**
_Properties truncated due to depth limit._
**Option 9:**
_Properties truncated due to depth limit._
Properties of `qTreePath`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMeasureInfo`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMeasureInfo` | [NxMeasureInfo](#nxmeasureinfo) | Layout for _NxInlineMeasureDef_. |
Properties of `NxMeasureInfo`
| Name | Type | Description |
| --- | --- | --- |
| `qFallbackTitle` | `string` | Corresponds to the label of the measure. If the label is not defined then the measure name is used. |
| `qApprMaxGlyphCount` | `integer` | Length of the longest value in the field. |
| `qCardinal` | `integer` | Number of distinct field values. |
| `qSortIndicator` | oneOf(N \| A \| D) | |
| `qNumFormat` | [FieldAttributes](#fieldattributes) | Sets the formatting of a field. The properties of _qFieldAttributes_ and the formatting mechanism are described below. ### Formatting mechanism The formatting mechanism depends on the type set in _qType,_ as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
### Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: * If a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ . * If _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ). * The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. ### Type is INTEGER The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used . ### Type is REAL The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. * If no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is FIX The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ). * If no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used. ### Type is MONEY The following applies: * If a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). * If no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ). ### Type is ASCII No formatting, _qFmt_ is ignored. |
| `qMin` | `number` | Lowest value in the range. |
| `qMax` | `number` | Highest value in the range. |
| `qError` | [NxValidationError](#nxvalidationerror) | |
| `qReverseSort` | `boolean` | If set to true, it inverts the sort criteria in the field. |
| `qIsAutoFormat` | `boolean` | This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression. |
| `qAttrExprInfo` | `array` of [NxAttrExprInfo](#nxattrexprinfo) | List of attribute expressions. |
| `qAttrDimInfo` | `array` of [NxAttrDimInfo](#nxattrdiminfo) | List of attribute dimensions. |
| `qCalcCondMsg` | `string` | The message displayed if calculation condition is not fulfilled. |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qTrendLines` | `array` of [NxTrendline](#nxtrendline) | Calculated trendlines |
| `qMiniChart` | [NxMiniChart](#nxminichart) | |
Properties of `qSortIndicator`
**One of:**
**Option 1:**
_Properties truncated due to depth limit._
**Option 2:**
_Properties truncated due to depth limit._
**Option 3:**
_Properties truncated due to depth limit._
Properties of `qNumFormat`
_Properties truncated due to depth limit._
Properties of `qError`
_Properties truncated due to depth limit._
Properties of `qAttrExprInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttrDimInfo`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTrendLines`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMiniChart`
_Properties truncated due to depth limit._
---
### TreeDataDef
Defines the properties of a TreeData object.
For more information about the definition of a TreeData object, see _Generic object_.
| Name | Type | Description |
| --- | --- | --- |
| `qStateName` | `string` | Name of the alternate state. Default is current selections _$_ . |
| `qDimensions` | `array` of [NxTreeDimensionDef](#nxtreedimensiondef) | Array of dimensions. |
| `qInterColumnSortOrder` | `array of integer` | Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef. |
| `qSuppressZero` | `boolean` | Removes zero values. |
| `qSuppressMissing` | `boolean` | Removes missing values. |
| `qOpenFullyExpanded` | `boolean` | If this property is set to true, the cells are opened expanded. The default value is false. |
| `qPopulateMissing` | `boolean` | If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false. |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
| `qTitle` | [StringExpr](#stringexpr) | |
| `qInitialDataFetch` | `array` of [NxTreeDataOption](#nxtreedataoption) | Initial data set. This property is optional. |
| `qExpansionState` | `array` of [ExpansionData](#expansiondata) | Expansion state per dimension. |
| `qValueExprs` | `array` of [NxMeasure](#nxmeasure) | List of measures to calculate on the whole tree. |
| `qContextSetExpression` | `string` | Set Expression valid for the whole cube. Used to limit computations to the set specified. |
Properties of `qDimensions`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTreeDimensionDef` | [NxTreeDimensionDef](#nxtreedimensiondef) | |
Properties of `NxTreeDimensionDef`
| Name | Type | Description |
| --- | --- | --- |
| `qLibraryId` | `string` | Refers to a dimension stored in the library. |
| `qDef` | [NxInlineDimensionDef](#nxinlinedimensiondef) | |
| `qValueExprs` | `array` of [NxMeasure](#nxmeasure) | List of measures. |
| `qNullSuppression` | `boolean` | If set to true, no null values are returned. |
| `qOtherTotalSpec` | [OtherTotalSpecProp](#othertotalspecprop) | |
| `qShowAll` | `boolean` | If set to true, all dimension values are shown. |
| `qOtherLabel` | [StringExpr](#stringexpr) | |
| `qTotalLabel` | [StringExpr](#stringexpr) | |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qAttributeDimensions` | `array` of [NxAttrDimDef](#nxattrdimdef) | List of attribute dimensions. |
Properties of `qDef`
_Properties truncated due to depth limit._
Properties of `qValueExprs`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qOtherTotalSpec`
_Properties truncated due to depth limit._
Properties of `qOtherLabel`
_Properties truncated due to depth limit._
Properties of `qTotalLabel`
_Properties truncated due to depth limit._
Properties of `qCalcCondition`
_Properties truncated due to depth limit._
Properties of `qAttributeExpressions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttributeDimensions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qInterColumnSortOrder`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `` | `integer` | |
Properties of `qCalcCondition`
| Name | Type | Description |
| --- | --- | --- |
| `qCond` | [ValueExpr](#valueexpr) | |
| `qMsg` | [StringExpr](#stringexpr) | |
Properties of `qCond`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
Properties of `qMsg`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qTitle`
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to string. |
Properties of `qInitialDataFetch`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxTreeDataOption` | [NxTreeDataOption](#nxtreedataoption) | Specifies all the paging filters needed to define the tree to be fetched. |
Properties of `NxTreeDataOption`
| Name | Type | Description |
| --- | --- | --- |
| `qMaxNbrOfNodes` | `integer` | Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted. |
| `qTreeNodes` | `array` of [NxPageTreeNode](#nxpagetreenode) | Defines areas of the tree to be fetched. Areas must be defined left to right. |
| `qTreeLevels` | [NxPageTreeLevel](#nxpagetreelevel) | |
Properties of `qTreeNodes`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qTreeLevels`
_Properties truncated due to depth limit._
Properties of `qExpansionState`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `ExpansionData` | [ExpansionData](#expansiondata) | |
Properties of `ExpansionData`
| Name | Type | Description |
| --- | --- | --- |
| `qExcludeList` | `boolean` | |
| `qPos` | [PositionMark](#positionmark) | |
Properties of `qPos`
_Properties truncated due to depth limit._
Properties of `qValueExprs`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxMeasure` | [NxMeasure](#nxmeasure) | Either **qDef** or **qLibraryId** must be set, but not both. If both are set, the library measure's qDef and qLabel will be used.
If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.
A measure that is set in the library can be used by many objects.
expressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure. Attribute expressions do not affect the layout of an object. The sorting order is unchanged.
|
Properties of `NxMeasure`
| Name | Type | Description |
| --- | --- | --- |
| `qLibraryId` | `string` | Refers to a measure stored in the library. |
| `qDef` | [NxInlineMeasureDef](#nxinlinemeasuredef) | |
| `qSortBy` | [SortCriteria](#sortcriteria) | |
| `qAttributeExpressions` | `array` of [NxAttrExprDef](#nxattrexprdef) | List of attribute expressions. |
| `qAttributeDimensions` | `array` of [NxAttrDimDef](#nxattrdimdef) | List of attribute dimensions. |
| `qCalcCond` | [ValueExpr](#valueexpr) | |
| `qCalcCondition` | [NxCalcCond](#nxcalccond) | |
| `qTrendLines` | `array` of [NxTrendlineDef](#nxtrendlinedef) | Specifies trendlines for this measure. |
| `qMiniChartDef` | [NxMiniChartDef](#nxminichartdef) | |
Properties of `qDef`
_Properties truncated due to depth limit._
Properties of `qSortBy`
_Properties truncated due to depth limit._
Properties of `qAttributeExpressions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qAttributeDimensions`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qCalcCond`
_Properties truncated due to depth limit._
Properties of `qCalcCondition`
_Properties truncated due to depth limit._
Properties of `qTrendLines`
**Array items:**
_Properties truncated due to depth limit._
Properties of `qMiniChartDef`
_Properties truncated due to depth limit._
---
### UndoInfo
Displays information about the number of possible undos and redos. Is the layout for _UndoInfoDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qUndoCount` | `integer` | Number of possible undos. |
| `qRedoCount` | `integer` | Number of possible redos. |
---
### UndoInfoDef
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.
---
### UsageEnum
| Name | Type | Description |
| --- | --- | --- |
| `UsageEnum` | oneOf(ANALYTICS \| DATA_PREPARATION \| DATAFLOW_PREP \| SINGLE_TABLE_PREP \| DIRECT_QUERY_MODE) | |
Properties of `UsageEnum`
**One of:**
**Option 1:**
| Name | Type | Description |
| --- | --- | --- |
| `ANALYTICS` | `object` | |
**Option 2:**
| Name | Type | Description |
| --- | --- | --- |
| `DATA_PREPARATION` | `object` | |
**Option 3:**
| Name | Type | Description |
| --- | --- | --- |
| `DATAFLOW_PREP` | `object` | |
**Option 4:**
| Name | Type | Description |
| --- | --- | --- |
| `SINGLE_TABLE_PREP` | `object` | |
**Option 5:**
| Name | Type | Description |
| --- | --- | --- |
| `DIRECT_QUERY_MODE` | `object` | |
---
### ValueExpr
| Name | Type | Description |
| --- | --- | --- |
| `qv` | `string` | Expression evaluated to dual. |
---
### ValueExpression
**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.
| Name | Type | Description |
| --- | --- | --- |
| `qExpr` | `string` | |
---
### VariableList
Lists the variables in an app. Is the layout for _VariableListDef_.
| Name | Type | Description |
| --- | --- | --- |
| `qItems` | `array` of [NxVariableListItem](#nxvariablelistitem) | List of the variables. |
Properties of `qItems`
**Array items:**
| Name | Type | Description |
| --- | --- | --- |
| `NxVariableListItem` | [NxVariableListItem](#nxvariablelistitem) | |
Properties of `NxVariableListItem`
| Name | Type | Description |
| --- | --- | --- |
| `qName` | `string` | Name of the variable. |
| `qDescription` | `string` | Description of the variable. |
| `qDefinition` | `string` | Definition of the variable. It can be a value or an expression. |
| `qIsConfig` | `boolean` | If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false. |
| `qIsReserved` | `boolean` | If set to true, it means that the variable is reserved. The default value is false. This parameter is optional. Examples: * _ScriptError_ is a reserved variable, set by the engine. * _DayNames_ is a reserved variable, set by the user. |
| `qMeta` | [NxMeta](#nxmeta) | Layout for _NxMetaDef_. |
| `qInfo` | [NxInfo](#nxinfo) | |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
| `qIsScriptCreated` | `boolean` | If set to true, it means that the variable was defined via script. |
Properties of `qMeta`
_Properties truncated due to depth limit._
Properties of `qInfo`
_Properties truncated due to depth limit._
---
### VariableListDef
Defines the list of variables in an app.
| Name | Type | Description |
| --- | --- | --- |
| `qType` | `string` | Type of variables to include in the list. |
| `qShowReserved` | `boolean` | Shows the reserved variables if set to true. |
| `qShowConfig` | `boolean` | Shows the system variables if set to true. |
| `qData` | [JsonObject](#jsonobject) | Contains dynamic JSON data specified by the client. |
| `qShowSession` | `boolean` | Shows the session variables if set to true. |
---