Qlik Sense Engine (qix)
Doc
Aborts any selection mode in an app. For more information about selection mode, see BeginSelections method.
Parameters
- qAccept booleanRequired
Set this parameter to true to accept the selections before exiting the selection mode.
Response
objectErrors
arrayAbortModal(qAccept)
const result = await doc.abortModal(true)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "AbortModal", "params": { "qAccept": true }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}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
- qStateName stringRequired
Name of the alternate state.
Response
objectErrors
arrayAddAlternateState(qStateName)
const result = await doc.addAlternateState("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "AddAlternateState", "params": { "qStateName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Adds a field on the fly.
Parameters
- qName stringRequired
Name of the field.
- qExpr stringRequired
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.
Response
- qSuccess boolean
Errors
arrayAddFieldFromExpression(qName, qExpr)
const result = await doc.addFieldFromExpression("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "AddFieldFromExpression", "params": { "qName": "value", "qExpr": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}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
- qStateName stringRequired
Name of the alternate state.
- qSourceStateName string
Name of existing state to copy the initial selections from
Response
objectErrors
arrayAddSessionAlternateState(qStateName, qSourceStateName?)
const result = await doc.addSessionAlternateState("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "AddSessionAlternateState", "params": { "qStateName": "value", "qSourceStateName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Applies a bookmark and verifies result dataset against originally selected values.
Parameters
- qId stringRequired
Identifier of the bookmark.
Response
- qResult objectExperimental
qResult properties
- qApplySuccess boolean
Apply successfully or not *
- qWarnings array of objectsExperimental
Field values verfication result *
qWarnings properties
- qState string
Alternate State *
- qField string
Field Name *
- qVerifyResult string
Can be one of: "NOT_VERIFIED""FIELD_VALUE_MATCH_ALL""FIELD_MISSING""FIELD_VALUE_MISSING""STATE_MISSING""SEARCH_NO_MATCH"
- qMissingValues array of strings Deprecated
Strings representing missing field values. Will be replaced by MissingDuals. *
- qMissingDuals array of objectsExperimental
Missing field values as duals, carrying both text and numeric parts. Number of values included is capped. Default cap is 20. *
qMissingDuals properties
- qText string
Text related to the field value. This parameter is optional.
- qIsNumeric boolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumber number
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qTotalMissing integerExperimental
Total count of missing field values *
-
- qGroupStateResult objectExperimental
Result of applying GroupState to multiple cyclic groups.
qGroupStateResult properties
- qApplySuccess boolean
When true, the operation was successful.
- qWarnings array of objectsExperimental
Lists which states failed to be applied and why.
qWarnings properties
- qState objectExperimental
qState properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qActiveFieldDef string
String defining the active field.
-
- qType string
Can be one of: "group_missing""group_not_applicable""fielddef_missing"
-
-
-
Errors
arrayApplyAndVerifyBookmark(qId)
const result = await doc.applyAndVerifyBookmark("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ApplyAndVerifyBookmark", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": { "qApplySuccess": true, "qWarnings": [ { "qState": "value", "qField": "value", "qVerifyResult": "NOT_VERIFIED", "qMissingValues": [ "value" ], "qMissingDuals": [ { "qText": "value", "qIsNumeric": true, "qNumber": 123 } ], "qTotalMissing": 123 } ], "qGroupStateResult": { "qApplySuccess": true, "qWarnings": [ { "qState": { "qInfo": { "qId": "value", "qType": "value" }, "qActiveFieldDef": "value" }, "qType": "group_missing" } ] } } }}Applies a bookmark.
Parameters
- qId stringRequired
Identifier of the bookmark.
Response
- qSuccess boolean
Errors
arrayApplyBookmark(qId)
const result = await doc.applyBookmark("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ApplyBookmark", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Parameters
- qGroupStates array of objectsRequired Experimental
qGroupStates properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qActiveFieldDef string
String defining the active field.
-
Response
- qResult objectExperimental
Result of applying GroupState to multiple cyclic groups.
qResult properties
- qApplySuccess boolean
When true, the operation was successful.
- qWarnings array of objectsExperimental
Lists which states failed to be applied and why.
qWarnings properties
- qState objectExperimental
qState properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qActiveFieldDef string
String defining the active field.
-
- qType string
Can be one of: "group_missing""group_not_applicable""fielddef_missing"
-
-
Errors
arrayApplyGroupStates(qGroupStates)
const result = await doc.applyGroupStates([ { "qInfo": { "qId": "value", "qType": "value" }, "qActiveFieldDef": "value" }])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ApplyGroupStates", "params": { "qGroupStates": [ { "qInfo": { "qId": "value", "qType": "value" }, "qActiveFieldDef": "value" } ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": { "qApplySuccess": true, "qWarnings": [ { "qState": { "qInfo": { "qId": "value", "qType": "value" }, "qActiveFieldDef": "value" }, "qType": "group_missing" } ] } }}Apply temporary bookmark identified by Id.
Parameters
- qId stringRequired
Identifier of the temporary selection state
Response
- qReturn boolean
Errors
arrayApplyTemporaryBookmark(qId)
const result = await doc.applyTemporaryBookmark("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ApplyTemporaryBookmark", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}Back()
const result = await doc.back()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Back"}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Returns the number of entries on the back stack.
Response
- qReturn integer
Errors
arrayBackCount()
const result = await doc.backCount()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "BackCount"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": 123 }}Change the owner of a session app.
Parameters
- qNewOwnerId stringRequired
Identifier of the new app owner.
Response
- qSuccess boolean
Errors
arrayChangeSessionAppOwner(qNewOwnerId)
const result = await doc.changeSessionAppOwner("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ChangeSessionAppOwner", "params": { "qNewOwnerId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Add a session app to a space.
Parameters
- qSpaceId stringRequired
Identifier of the new space.
Response
- qSuccess boolean
Errors
arrayChangeSessionAppSpace(qSpaceId)
const result = await doc.changeSessionAppSpace("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ChangeSessionAppSpace", "params": { "qSpaceId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Checks if a given expression is valid.
Parameters
- qExpr stringRequired
Expression to check.
- qLabels array of strings
List of labels.
- qStrictFieldValidation boolean
If true, enforces strict validation of field references.
Response
- qErrorMsg string
- qBadFieldNames array of objects
qBadFieldNames properties
- qFrom integer
Position in the expression of the first character of the field name.
- qCount integer
Number of characters in the field name.
-
- qDangerousFieldNames array of objects
qDangerousFieldNames properties
- qFrom integer
Position in the expression of the first character of the field name.
- qCount integer
Number of characters in the field name.
-
Errors
arrayCheckExpression(qExpr, qLabels?, qStrictFieldValidation?)
const result = await doc.checkExpression("value", [ "value"], true)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CheckExpression", "params": { "qExpr": "value", "qLabels": [ "value" ], "qStrictFieldValidation": true }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qErrorMsg": "value", "qBadFieldNames": [ { "qFrom": 123, "qCount": 123 } ], "qDangerousFieldNames": [ { "qFrom": 123, "qCount": 123 } ] }}Checks if:
- A given expression is valid.
- A number is correct according to the locale.
Parameters
- qExpr stringRequired
Expression to check.
Response
- qErrorMsg string
- qBadFieldNames array of objects
qBadFieldNames properties
- qFrom integer
Position in the expression of the first character of the field name.
- qCount integer
Number of characters in the field name.
-
Errors
arrayCheckNumberOrExpression(qExpr)
const result = await doc.checkNumberOrExpression("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CheckNumberOrExpression", "params": { "qExpr": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qErrorMsg": "value", "qBadFieldNames": [ { "qFrom": 123, "qCount": 123 } ] }}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 } ] }
| 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 |
Response
- qErrors array of objects
qErrors properties
- 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.
-
Errors
arrayCheckScriptSyntax()
const result = await doc.checkScriptSyntax()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CheckScriptSyntax"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qErrors": [ { "qErrLen": 0, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0, "qSecondaryFailure": true } ] }}Clear selections in fields for current state. Locked fields are not cleared by default.
Parameters
- qLockedAlso boolean
When true, clears the selection for locked fields.
- qStateName string
Alternate state name. When set, applies to alternate state instead of current
Response
objectErrors
arrayClearAll(qLockedAlso?, qStateName?)
const result = await doc.clearAll(true, "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ClearAll", "params": { "qLockedAlso": true, "qStateName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Clears the soft properties of all generic objects in the app.
Response
objectErrors
arrayClearAllSoftPatches()
const result = await doc.clearAllSoftPatches()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ClearAllSoftPatches"}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}ClearUndoBuffer()
const result = await doc.clearUndoBuffer()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ClearUndoBuffer"}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Clones a bookmark.
Parameters
- qId stringRequired
Identifier of the object to clone.
Response
- qCloneId string
Errors
arrayCloneBookmark(qId)
const result = await doc.cloneBookmark("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CloneBookmark", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qCloneId": "value" }}Clones a dimension.
Parameters
- qId stringRequired
Identifier of the object to clone.
Response
- qCloneId string
Errors
arrayCloneDimension(qId)
const result = await doc.cloneDimension("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CloneDimension", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qCloneId": "value" }}Clones a measure.
Parameters
- qId stringRequired
Identifier of the object to clone.
Response
- qCloneId string
Errors
arrayCloneMeasure(qId)
const result = await doc.cloneMeasure("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CloneMeasure", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qCloneId": "value" }}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.
Parameters
- qId stringRequired
Identifier of the object to clone. The identifier must be a root object.
Response
- qCloneId string
Errors
arrayCloneObject(qId)
const result = await doc.cloneObject("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CloneObject", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qCloneId": "value" }}Commits the draft of an object that was previously created by invoking the CreateDraft method. Committing a draft replaces the corresponding published object.
Parameters
- qId stringRequired
Identifier of the draft to commit.
Response
objectErrors
arrayCommitDraft(qId)
const result = await doc.commitDraft("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CommitDraft", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Commits the current script version so that any future changes will be part of a new version.
Parameters
- qCommitMessage string
Name of the version.
Only applicable to QCS.
Response
objectErrors
arrayCommitScript(qCommitMessage?)
const result = await doc.commitScript("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CommitScript", "params": { "qCommitMessage": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Creates a bookmark.
Parameters
- qProp objectRequired
Properties for the object.
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
- qIncludeVariables booleanExperimental
If true all variables will be stored in the bookmark.
- qDistinctValues booleanExperimental
If true all selected values will be stored distinct, i.e. searchstrings will not be kept.
-
Response
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qReturn object
qReturn properties
- 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.
-
Errors
arrayCreateBookmark(qProp)
const result = await doc.createBookmark({ "qInfo": { "qId": "value", "qType": "value" }, "qMetaDef": {}, "qIncludeVariables": false, "qDistinctValues": false})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateBookmark", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qMetaDef": {}, "qIncludeVariables": false, "qDistinctValues": false } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfo": { "qId": "value", "qType": "value" }, "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Creates a bookmark with softpatches.
Parameters
- qProp objectRequired
Properties for the object.
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
- qIncludeVariables booleanExperimental
If true all variables will be stored in the bookmark.
- qDistinctValues booleanExperimental
If true all selected values will be stored distinct, i.e. searchstrings will not be kept.
-
- qObjectIdsToPatch array of strings
Add softpatches for this objects if available. If empty all softpatches are added to the bookmark.
Response
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qReturn object
qReturn properties
- 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.
-
Errors
arrayCreateBookmarkEx(qProp, qObjectIdsToPatch?)
const result = await doc.createBookmarkEx({ "qInfo": { "qId": "value", "qType": "value" }, "qMetaDef": {}, "qIncludeVariables": false, "qDistinctValues": false}, [ "value"])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateBookmarkEx", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qMetaDef": {}, "qIncludeVariables": false, "qDistinctValues": false }, "qObjectIdsToPatch": [ "value" ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfo": { "qId": "value", "qType": "value" }, "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Creates a connection. A connection indicates from which data source the data should be taken.
Parameters
- qConnection objectRequired
Information about the connection.
qConnection properties
- qId string
Identifier of the connection. Is generated by the engine and is unique.
- qName string
Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection.
- qConnectionString string
One of:
- ODBC CONNECT TO [<provider name>]
- OLEDB CONNECT TO [<provider name>]
- CUSTOM CONNECT TO [<provider name>]
- "<local absolute or relative path, UNC path>"
- "<URL>"
Connection string. This parameter is mandatory and must be set when creating or modifying a connection.
- qType string
One of:
- ODBC
- OLEDB
- <Name of the custom connection file>
- folder
- internet
Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive.
- qUserName string
Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the user name.
- qPassword string
Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the password.
- qModifiedDate string
Is generated by the engine. Creation date of the connection or last modification date of the connection.
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qLogOn string
Can be one of: "LOG_ON_SERVICE_USER""LOG_ON_CURRENT_USER"
-
Response
- qConnectionId string
Errors
arrayCreateConnection(qConnection)
const result = await doc.createConnection({ "qId": "value", "qName": "value", "qConnectionString": "value", "qType": "value", "qUserName": "value", "qPassword": "value", "qModifiedDate": "value", "qMeta": { "qName": "value" }, "qLogOn": "LOG_ON_SERVICE_USER"})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateConnection", "params": { "qConnection": { "qId": "value", "qName": "value", "qConnectionString": "value", "qType": "value", "qUserName": "value", "qPassword": "value", "qModifiedDate": "value", "qMeta": { "qName": "value" }, "qLogOn": "LOG_ON_SERVICE_USER" } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qConnectionId": "value" }}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
- qProp objectRequired
Information about the properties.
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qDim object
qDim properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of dimension names.
- qFieldLabels array of strings
Array of dimension labels.
- qLabelExpression string
- qAlias string
Alias of the dimension.
- qScriptGenerated boolean Deprecated
- qOrigin string
Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"
-
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
-
Response
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qReturn object
qReturn properties
- 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.
-
Errors
arrayCreateDimension(qProp)
const result = await doc.createDimension({ "qInfo": { "qId": "value", "qType": "value" }, "qDim": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qLabelExpression": "value", "qAlias": "value", "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qMetaDef": {}})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateDimension", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qDim": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qLabelExpression": "value", "qAlias": "value", "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qMetaDef": {} } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfo": { "qId": "value", "qType": "value" }, "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}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.
Parameters
- qId stringRequired
Identifier of the object to create a draft from.
Response
- qDraftId string
Errors
arrayCreateDraft(qId)
const result = await doc.createDraft("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateDraft", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qDraftId": "value" }}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
- qProp objectRequired
Information about the properties.
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qMeasure object
qMeasure properties
- qLabel string
Label of the measure.
- qDef string
Definition of the measure.
- qGrouping string
Can be one of: "N""H""C"
- qExpressions array of strings
Array of expressions.
- qActiveExpression integer
Index to the active expression in a measure.
- qLabelExpression string
Optional expression used for dynamic label.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qScriptGenerated boolean Deprecated
- qOrigin string
Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"
-
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
-
Response
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qReturn object
qReturn properties
- 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.
-
Errors
arrayCreateMeasure(qProp)
const result = await doc.createMeasure({ "qInfo": { "qId": "value", "qType": "value" }, "qMeasure": { "qLabel": "value", "qDef": "value", "qGrouping": "N", "qExpressions": [ "value" ], "qActiveExpression": 123, "qLabelExpression": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qMetaDef": {}})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateMeasure", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qMeasure": { "qLabel": "value", "qDef": "value", "qGrouping": "N", "qExpressions": [ "value" ], "qActiveExpression": 123, "qLabelExpression": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qMetaDef": {} } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfo": { "qId": "value", "qType": "value" }, "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}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.
Parameters
- qProp objectRequired
Information about the object.
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qExtendsId string
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
- qStateName string
Name of the alternate state. Default is current selections $ .
- qAppObjectListDef object
Defines the list of objects in an app.
An app object is a generic object created at app level.qAppObjectListDef properties
- qType string
Type of the app list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qBookmarkListDef object
Defines the list of bookmarks.
qBookmarkListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
- qIncludePatches boolean
Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
-
- qChildListDef object
Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.
qChildListDef properties
- qData object
Contains dynamic JSON data specified by the client.
-
- qDimensionListDef object
Defines the lists of dimensions.
qDimensionListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qEmbeddedSnapshotDef object
Defines the embedded snapshot in a generic object.
Properties
"EmbeddedSnapshotDef": {}
- qExtensionListDef object
Obsolete, use qrs API's to fetch extensions.
- qFieldListDef object
Defines the fields to show.
qFieldListDef properties
- 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.
-
- qHyperCubeDef object
Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.
qHyperCubeDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qDimensions array of objects
Array of dimensions.
qDimensions properties
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qNullSuppression boolean
If set to true, no null values are returned.
- qIncludeElemValue boolean
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qShowTotal boolean
- qShowAll boolean
If set to true, all dimension values are shown.
- qOtherLabel object
qOtherLabel properties
- qv string
Expression evaluated to string.
-
- qTotalLabel object
qTotalLabel properties
- qv string
Expression evaluated to string.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
-
- qMeasures array of objects
Array of measures.
qMeasures properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qInterColumnSortOrder array of integers
Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.
- qSuppressZero boolean
Removes zero values.
- qSuppressMissing boolean
Removes missing values.
- qInitialDataFetch array of objects
Initial data set.
qInitialDataFetch properties
- 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 ).
-
- qReductionMode string
Can be one of: "N""D1""S""C""ST"
- qMode string
Can be one of: "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 object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qSortbyYValue integer
To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.
- qTitle object
qTitle properties
- qv string
Expression evaluated to string.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qColumnOrder array of integers
The order of the columns.
- qExpansionState array of objectsExperimental
Expansion state per dimension for pivot mode ( qMode is P).
qExpansionState properties
- qExcludeList boolean
- qPos object
qPos properties
- qDimName string
- qElemNo array of integers
- qElemValues array of strings
-
-
- qDynamicScript array of stringsExperimental
Hypercube Modifier Dynamic script string
- qContextSetExpression string
Set expression valid for the whole cube, limiting computations to the specified set.
- qSuppressMeasureTotals boolean
When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
-
- qLayoutExclude object
Contains JSON to be excluded from validation.
- qListObjectDef object
Defines the properties of a list object. For more information about the definition of a list object, see Generic object.
qListObjectDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qAutoSortByState object
qAutoSortByState properties
- qDisplayNumberOfRows integer
This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.
-
- qFrequencyMode string
Can be one of: "N""V""P""R"
- qShowAlternatives boolean
If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.
- qInitialDataFetch array of objects
Fetches an initial data set.
qInitialDataFetch properties
- 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 ).
-
- qExpressions array of objects
Lists the expressions in the list object. This parameter is optional.
qExpressions properties
- qExpr string
Value of the expression.
- qLibraryId string
Refers to an expression stored in the library.
-
- qDirectQuerySimplifiedView booleanExperimental
If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
-
- qMeasureListDef object
Defines the list of measures.
qMeasureListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qMediaListDef object
Defines the list of media files.
This struct is deprecated.Properties
"qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.
- qNxLibraryDimensionDef object
qNxLibraryDimensionDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of dimension names.
- qFieldLabels array of strings
Array of dimension labels.
- qLabelExpression string
- qAlias string
Alias of the dimension.
- qScriptGenerated boolean Deprecated
- qOrigin string
Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"
-
- qNxLibraryMeasureDef object
qNxLibraryMeasureDef properties
- qLabel string
Label of the measure.
- qDef string
Definition of the measure.
- qGrouping string
Can be one of: "N""H""C"
- qExpressions array of strings
Array of expressions.
- qActiveExpression integer
Index to the active expression in a measure.
- qLabelExpression string
Optional expression used for dynamic label.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qScriptGenerated boolean Deprecated
- qOrigin string
Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"
-
- qSelectionObjectDef object
To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.
Properties
"qSelectionObjectDef": {}
qSelectionObjectDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
-
- qStaticContentUrlDef objectIn addition, this structure can contain dynamic properties.
qStaticContentUrlDef properties
- qUrl string
Relative path of the thumbnail.
-
- qStringExpression object
Properties
Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:
- < expression > is a string
The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.A string expression is not evaluated, if the expression is surrounded by simple quotes.The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.qStringExpression properties
- qExpr string
- qTreeDataDef object
Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.
qTreeDataDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qDimensions array of objects
Array of dimensions.
qDimensions properties
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qValueExprs array of objects
List of measures.
qValueExprs properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qNullSuppression boolean
If set to true, no null values are returned.
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qShowAll boolean
If set to true, all dimension values are shown.
- qOtherLabel object
qOtherLabel properties
- qv string
Expression evaluated to string.
-
- qTotalLabel object
qTotalLabel properties
- qv string
Expression evaluated to string.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
-
- qInterColumnSortOrder array of integers
Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.
- qSuppressZero boolean
Removes zero values.
- 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 object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTitle object
qTitle properties
- qv string
Expression evaluated to string.
-
- qInitialDataFetch array of objects
Initial data set. This property is optional.
qInitialDataFetch properties
- 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 objects
Defines areas of the tree to be fetched. Areas must be defined left to right.
qTreeNodes properties
- qArea object
qArea properties
- 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 ).
-
- qAllValues boolean
When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
-
- qTreeLevels object
qTreeLevels properties
- qLeft integer
The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.
- qDepth integer
Number of dimensions to include in the tree.
-
-
- qExpansionState array of objectsExperimental
Expansion state per dimension.
qExpansionState properties
- qExcludeList boolean
- qPos object
qPos properties
- qDimName string
- qElemNo array of integers
- qElemValues array of strings
-
-
- qValueExprs array of objects
List of measures to calculate on the whole tree.
qValueExprs properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qContextSetExpression string
Set expression valid for the whole cube, limiting computations to the specified set.
-
- qUndoInfoDef object
Defines if an object should contain information on the number of possible undo and redo.
Properties
"qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.
- qValueExpression object
Properties
Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:
- < expression > is a string.
The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.The expression is evaluated as a numeric.qValueExpression properties
- qExpr string
- qVariableListDef object
Defines the list of variables in an app.
qVariableListDef properties
- qType string
Type of variables to include in the list.
- qShowReserved boolean
Shows the reserved variables if set to true.
- qShowConfig boolean
Shows the system variables if set to true.
- qData object
Contains dynamic JSON data specified by the client.
- qShowSession boolean
Shows the session variables if set to true.
-
additional optional properties
- object objectPrivateAny of:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
-
-
Response
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qReturn object
qReturn properties
- 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.
-
Errors
arrayCreateObject(qProp)
const result = await doc.createObject({ "qInfo": { "qId": "value", "qType": "value" }, "qExtendsId": "value", "qMetaDef": {}, "qStateName": "value", "qAppObjectListDef": { "qType": "value", "qData": {} }, "qBookmarkListDef": { "qType": "value", "qData": {}, "qIncludePatches": true }, "qChildListDef": { "qData": {} }, "qDimensionListDef": { "qType": "value", "qData": {} }, "qEmbeddedSnapshotDef": {}, "qExtensionListDef": {}, "qFieldListDef": { "qShowSystem": false, "qShowHidden": false, "qShowSemantic": false, "qShowSrcTables": false, "qShowDefinitionOnly": false, "qShowDerivedFields": false, "qShowImplicit": false }, "qHyperCubeDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qNullSuppression": true, "qIncludeElemValue": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowTotal": true, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCond": { "qv": "value" }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } } } ], "qMeasures": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qReductionMode": "N", "qMode": "S", "qPseudoDimPos": -1, "qNoOfLeftDims": -1, "qAlwaysFullyExpanded": false, "qMaxStackedCells": 5000, "qPopulateMissing": false, "qShowTotalsAbove": false, "qIndentMode": false, "qCalcCond": { "qv": "value" }, "qSortbyYValue": 0, "qTitle": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qColumnOrder": [ 123 ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qDynamicScript": [ "value" ], "qContextSetExpression": "value", "qSuppressMeasureTotals": true }, "qLayoutExclude": {}, "qListObjectDef": { "qStateName": "value", "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qAutoSortByState": { "qDisplayNumberOfRows": 123 }, "qFrequencyMode": "N", "qShowAlternatives": true, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qExpressions": [ { "qExpr": "value", "qLibraryId": "value" } ], "qDirectQuerySimplifiedView": true }, "qMeasureListDef": { "qType": "value", "qData": {} }, "qMediaListDef": {}, "qNxLibraryDimensionDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qLabelExpression": "value", "qAlias": "value", "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qNxLibraryMeasureDef": { "qLabel": "value", "qDef": "value", "qGrouping": "N", "qExpressions": [ "value" ], "qActiveExpression": 123, "qLabelExpression": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qSelectionObjectDef": { "qStateName": "value" }, "qStaticContentUrlDef": { "qUrl": "value" }, "qStringExpression": { "qExpr": "value" }, "qTreeDataDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qNullSuppression": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ] } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qOpenFullyExpanded": false, "qPopulateMissing": false, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTitle": { "qv": "value" }, "qInitialDataFetch": [ { "qMaxNbrOfNodes": 123, "qTreeNodes": [ { "qArea": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qAllValues": true } ], "qTreeLevels": { "qLeft": 123, "qDepth": -1 } } ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qContextSetExpression": "value" }, "qUndoInfoDef": {}, "qValueExpression": { "qExpr": "value" }, "qVariableListDef": { "qType": "value", "qShowReserved": true, "qShowConfig": true, "qData": {}, "qShowSession": true }})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateObject", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qExtendsId": "value", "qMetaDef": {}, "qStateName": "value", "qAppObjectListDef": { "qType": "value", "qData": {} }, "qBookmarkListDef": { "qType": "value", "qData": {}, "qIncludePatches": true }, "qChildListDef": { "qData": {} }, "qDimensionListDef": { "qType": "value", "qData": {} }, "qEmbeddedSnapshotDef": {}, "qExtensionListDef": {}, "qFieldListDef": { "qShowSystem": false, "qShowHidden": false, "qShowSemantic": false, "qShowSrcTables": false, "qShowDefinitionOnly": false, "qShowDerivedFields": false, "qShowImplicit": false }, "qHyperCubeDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qNullSuppression": true, "qIncludeElemValue": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowTotal": true, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCond": { "qv": "value" }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } } } ], "qMeasures": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qReductionMode": "N", "qMode": "S", "qPseudoDimPos": -1, "qNoOfLeftDims": -1, "qAlwaysFullyExpanded": false, "qMaxStackedCells": 5000, "qPopulateMissing": false, "qShowTotalsAbove": false, "qIndentMode": false, "qCalcCond": { "qv": "value" }, "qSortbyYValue": 0, "qTitle": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qColumnOrder": [ 123 ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qDynamicScript": [ "value" ], "qContextSetExpression": "value", "qSuppressMeasureTotals": true }, "qLayoutExclude": {}, "qListObjectDef": { "qStateName": "value", "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qAutoSortByState": { "qDisplayNumberOfRows": 123 }, "qFrequencyMode": "N", "qShowAlternatives": true, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qExpressions": [ { "qExpr": "value", "qLibraryId": "value" } ], "qDirectQuerySimplifiedView": true }, "qMeasureListDef": { "qType": "value", "qData": {} }, "qMediaListDef": {}, "qNxLibraryDimensionDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qLabelExpression": "value", "qAlias": "value", "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qNxLibraryMeasureDef": { "qLabel": "value", "qDef": "value", "qGrouping": "N", "qExpressions": [ "value" ], "qActiveExpression": 123, "qLabelExpression": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qSelectionObjectDef": { "qStateName": "value" }, "qStaticContentUrlDef": { "qUrl": "value" }, "qStringExpression": { "qExpr": "value" }, "qTreeDataDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qNullSuppression": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ] } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qOpenFullyExpanded": false, "qPopulateMissing": false, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTitle": { "qv": "value" }, "qInitialDataFetch": [ { "qMaxNbrOfNodes": 123, "qTreeNodes": [ { "qArea": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qAllValues": true } ], "qTreeLevels": { "qLeft": 123, "qDepth": -1 } } ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qContextSetExpression": "value" }, "qUndoInfoDef": {}, "qValueExpression": { "qExpr": "value" }, "qVariableListDef": { "qType": "value", "qShowReserved": true, "qShowConfig": true, "qData": {}, "qShowSession": true } } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfo": { "qId": "value", "qType": "value" }, "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}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.
Parameters
- qProp objectRequired
Information about the object.
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qExtendsId string
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
- qStateName string
Name of the alternate state. Default is current selections $ .
- qAppObjectListDef object
Defines the list of objects in an app.
An app object is a generic object created at app level.qAppObjectListDef properties
- qType string
Type of the app list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qBookmarkListDef object
Defines the list of bookmarks.
qBookmarkListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
- qIncludePatches boolean
Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
-
- qChildListDef object
Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.
qChildListDef properties
- qData object
Contains dynamic JSON data specified by the client.
-
- qDimensionListDef object
Defines the lists of dimensions.
qDimensionListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qEmbeddedSnapshotDef object
Defines the embedded snapshot in a generic object.
Properties
"EmbeddedSnapshotDef": {}
- qExtensionListDef object
Obsolete, use qrs API's to fetch extensions.
- qFieldListDef object
Defines the fields to show.
qFieldListDef properties
- 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.
-
- qHyperCubeDef object
Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.
qHyperCubeDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qDimensions array of objects
Array of dimensions.
qDimensions properties
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qNullSuppression boolean
If set to true, no null values are returned.
- qIncludeElemValue boolean
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qShowTotal boolean
- qShowAll boolean
If set to true, all dimension values are shown.
- qOtherLabel object
qOtherLabel properties
- qv string
Expression evaluated to string.
-
- qTotalLabel object
qTotalLabel properties
- qv string
Expression evaluated to string.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
-
- qMeasures array of objects
Array of measures.
qMeasures properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qInterColumnSortOrder array of integers
Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.
- qSuppressZero boolean
Removes zero values.
- qSuppressMissing boolean
Removes missing values.
- qInitialDataFetch array of objects
Initial data set.
qInitialDataFetch properties
- 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 ).
-
- qReductionMode string
Can be one of: "N""D1""S""C""ST"
- qMode string
Can be one of: "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 object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qSortbyYValue integer
To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.
- qTitle object
qTitle properties
- qv string
Expression evaluated to string.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qColumnOrder array of integers
The order of the columns.
- qExpansionState array of objectsExperimental
Expansion state per dimension for pivot mode ( qMode is P).
qExpansionState properties
- qExcludeList boolean
- qPos object
qPos properties
- qDimName string
- qElemNo array of integers
- qElemValues array of strings
-
-
- qDynamicScript array of stringsExperimental
Hypercube Modifier Dynamic script string
- qContextSetExpression string
Set expression valid for the whole cube, limiting computations to the specified set.
- qSuppressMeasureTotals boolean
When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
-
- qLayoutExclude object
Contains JSON to be excluded from validation.
- qListObjectDef object
Defines the properties of a list object. For more information about the definition of a list object, see Generic object.
qListObjectDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qAutoSortByState object
qAutoSortByState properties
- qDisplayNumberOfRows integer
This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.
-
- qFrequencyMode string
Can be one of: "N""V""P""R"
- qShowAlternatives boolean
If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.
- qInitialDataFetch array of objects
Fetches an initial data set.
qInitialDataFetch properties
- 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 ).
-
- qExpressions array of objects
Lists the expressions in the list object. This parameter is optional.
qExpressions properties
- qExpr string
Value of the expression.
- qLibraryId string
Refers to an expression stored in the library.
-
- qDirectQuerySimplifiedView booleanExperimental
If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
-
- qMeasureListDef object
Defines the list of measures.
qMeasureListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qMediaListDef object
Defines the list of media files.
This struct is deprecated.Properties
"qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.
- qNxLibraryDimensionDef object
qNxLibraryDimensionDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of dimension names.
- qFieldLabels array of strings
Array of dimension labels.
- qLabelExpression string
- qAlias string
Alias of the dimension.
- qScriptGenerated boolean Deprecated
- qOrigin string
Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"
-
- qNxLibraryMeasureDef object
qNxLibraryMeasureDef properties
- qLabel string
Label of the measure.
- qDef string
Definition of the measure.
- qGrouping string
Can be one of: "N""H""C"
- qExpressions array of strings
Array of expressions.
- qActiveExpression integer
Index to the active expression in a measure.
- qLabelExpression string
Optional expression used for dynamic label.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qScriptGenerated boolean Deprecated
- qOrigin string
Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"
-
- qSelectionObjectDef object
To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.
Properties
"qSelectionObjectDef": {}
qSelectionObjectDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
-
- qStaticContentUrlDef objectIn addition, this structure can contain dynamic properties.
qStaticContentUrlDef properties
- qUrl string
Relative path of the thumbnail.
-
- qStringExpression object
Properties
Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:
- < expression > is a string
The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.A string expression is not evaluated, if the expression is surrounded by simple quotes.The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.qStringExpression properties
- qExpr string
- qTreeDataDef object
Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.
qTreeDataDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qDimensions array of objects
Array of dimensions.
qDimensions properties
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qValueExprs array of objects
List of measures.
qValueExprs properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qNullSuppression boolean
If set to true, no null values are returned.
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qShowAll boolean
If set to true, all dimension values are shown.
- qOtherLabel object
qOtherLabel properties
- qv string
Expression evaluated to string.
-
- qTotalLabel object
qTotalLabel properties
- qv string
Expression evaluated to string.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
-
- qInterColumnSortOrder array of integers
Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.
- qSuppressZero boolean
Removes zero values.
- 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 object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTitle object
qTitle properties
- qv string
Expression evaluated to string.
-
- qInitialDataFetch array of objects
Initial data set. This property is optional.
qInitialDataFetch properties
- 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 objects
Defines areas of the tree to be fetched. Areas must be defined left to right.
qTreeNodes properties
- qArea object
qArea properties
- 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 ).
-
- qAllValues boolean
When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
-
- qTreeLevels object
qTreeLevels properties
- qLeft integer
The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.
- qDepth integer
Number of dimensions to include in the tree.
-
-
- qExpansionState array of objectsExperimental
Expansion state per dimension.
qExpansionState properties
- qExcludeList boolean
- qPos object
qPos properties
- qDimName string
- qElemNo array of integers
- qElemValues array of strings
-
-
- qValueExprs array of objects
List of measures to calculate on the whole tree.
qValueExprs properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qContextSetExpression string
Set expression valid for the whole cube, limiting computations to the specified set.
-
- qUndoInfoDef object
Defines if an object should contain information on the number of possible undo and redo.
Properties
"qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.
- qValueExpression object
Properties
Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:
- < expression > is a string.
The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.The expression is evaluated as a numeric.qValueExpression properties
- qExpr string
- qVariableListDef object
Defines the list of variables in an app.
qVariableListDef properties
- qType string
Type of variables to include in the list.
- qShowReserved boolean
Shows the reserved variables if set to true.
- qShowConfig boolean
Shows the system variables if set to true.
- qData object
Contains dynamic JSON data specified by the client.
- qShowSession boolean
Shows the session variables if set to true.
-
additional optional properties
- object objectPrivateAny of:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
-
-
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayCreateSessionObject(qProp)
const result = await doc.createSessionObject({ "qInfo": { "qId": "value", "qType": "value" }, "qExtendsId": "value", "qMetaDef": {}, "qStateName": "value", "qAppObjectListDef": { "qType": "value", "qData": {} }, "qBookmarkListDef": { "qType": "value", "qData": {}, "qIncludePatches": true }, "qChildListDef": { "qData": {} }, "qDimensionListDef": { "qType": "value", "qData": {} }, "qEmbeddedSnapshotDef": {}, "qExtensionListDef": {}, "qFieldListDef": { "qShowSystem": false, "qShowHidden": false, "qShowSemantic": false, "qShowSrcTables": false, "qShowDefinitionOnly": false, "qShowDerivedFields": false, "qShowImplicit": false }, "qHyperCubeDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qNullSuppression": true, "qIncludeElemValue": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowTotal": true, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCond": { "qv": "value" }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } } } ], "qMeasures": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qReductionMode": "N", "qMode": "S", "qPseudoDimPos": -1, "qNoOfLeftDims": -1, "qAlwaysFullyExpanded": false, "qMaxStackedCells": 5000, "qPopulateMissing": false, "qShowTotalsAbove": false, "qIndentMode": false, "qCalcCond": { "qv": "value" }, "qSortbyYValue": 0, "qTitle": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qColumnOrder": [ 123 ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qDynamicScript": [ "value" ], "qContextSetExpression": "value", "qSuppressMeasureTotals": true }, "qLayoutExclude": {}, "qListObjectDef": { "qStateName": "value", "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qAutoSortByState": { "qDisplayNumberOfRows": 123 }, "qFrequencyMode": "N", "qShowAlternatives": true, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qExpressions": [ { "qExpr": "value", "qLibraryId": "value" } ], "qDirectQuerySimplifiedView": true }, "qMeasureListDef": { "qType": "value", "qData": {} }, "qMediaListDef": {}, "qNxLibraryDimensionDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qLabelExpression": "value", "qAlias": "value", "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qNxLibraryMeasureDef": { "qLabel": "value", "qDef": "value", "qGrouping": "N", "qExpressions": [ "value" ], "qActiveExpression": 123, "qLabelExpression": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qSelectionObjectDef": { "qStateName": "value" }, "qStaticContentUrlDef": { "qUrl": "value" }, "qStringExpression": { "qExpr": "value" }, "qTreeDataDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qNullSuppression": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ] } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qOpenFullyExpanded": false, "qPopulateMissing": false, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTitle": { "qv": "value" }, "qInitialDataFetch": [ { "qMaxNbrOfNodes": 123, "qTreeNodes": [ { "qArea": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qAllValues": true } ], "qTreeLevels": { "qLeft": 123, "qDepth": -1 } } ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qContextSetExpression": "value" }, "qUndoInfoDef": {}, "qValueExpression": { "qExpr": "value" }, "qVariableListDef": { "qType": "value", "qShowReserved": true, "qShowConfig": true, "qData": {}, "qShowSession": true }})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateSessionObject", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qExtendsId": "value", "qMetaDef": {}, "qStateName": "value", "qAppObjectListDef": { "qType": "value", "qData": {} }, "qBookmarkListDef": { "qType": "value", "qData": {}, "qIncludePatches": true }, "qChildListDef": { "qData": {} }, "qDimensionListDef": { "qType": "value", "qData": {} }, "qEmbeddedSnapshotDef": {}, "qExtensionListDef": {}, "qFieldListDef": { "qShowSystem": false, "qShowHidden": false, "qShowSemantic": false, "qShowSrcTables": false, "qShowDefinitionOnly": false, "qShowDerivedFields": false, "qShowImplicit": false }, "qHyperCubeDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qNullSuppression": true, "qIncludeElemValue": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowTotal": true, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCond": { "qv": "value" }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } } } ], "qMeasures": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qReductionMode": "N", "qMode": "S", "qPseudoDimPos": -1, "qNoOfLeftDims": -1, "qAlwaysFullyExpanded": false, "qMaxStackedCells": 5000, "qPopulateMissing": false, "qShowTotalsAbove": false, "qIndentMode": false, "qCalcCond": { "qv": "value" }, "qSortbyYValue": 0, "qTitle": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qColumnOrder": [ 123 ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qDynamicScript": [ "value" ], "qContextSetExpression": "value", "qSuppressMeasureTotals": true }, "qLayoutExclude": {}, "qListObjectDef": { "qStateName": "value", "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qAutoSortByState": { "qDisplayNumberOfRows": 123 }, "qFrequencyMode": "N", "qShowAlternatives": true, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qExpressions": [ { "qExpr": "value", "qLibraryId": "value" } ], "qDirectQuerySimplifiedView": true }, "qMeasureListDef": { "qType": "value", "qData": {} }, "qMediaListDef": {}, "qNxLibraryDimensionDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qLabelExpression": "value", "qAlias": "value", "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qNxLibraryMeasureDef": { "qLabel": "value", "qDef": "value", "qGrouping": "N", "qExpressions": [ "value" ], "qActiveExpression": 123, "qLabelExpression": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qSelectionObjectDef": { "qStateName": "value" }, "qStaticContentUrlDef": { "qUrl": "value" }, "qStringExpression": { "qExpr": "value" }, "qTreeDataDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qNullSuppression": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ] } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qOpenFullyExpanded": false, "qPopulateMissing": false, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTitle": { "qv": "value" }, "qInitialDataFetch": [ { "qMaxNbrOfNodes": 123, "qTreeNodes": [ { "qArea": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qAllValues": true } ], "qTreeLevels": { "qLeft": 123, "qDepth": -1 } } ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qContextSetExpression": "value" }, "qUndoInfoDef": {}, "qValueExpression": { "qExpr": "value" }, "qVariableListDef": { "qType": "value", "qShowReserved": true, "qShowConfig": true, "qData": {}, "qShowSession": true } } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Creates a transient variable.
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
- qProp objectRequired
Name of the variable. Variable names are case sensitive.
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
- qName string
Name of the variable. The name must be unique. This parameter is mandatory.
- qComment string
Comment related to the variable. This parameter is optional.
- qNumberPresentation object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberPresentation properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- 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 object
qConstraints properties
- qType string
Can be one of: "any""number""text"
- qValuesText array of strings
- qValuesNum array of numbers
-
-
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayCreateSessionVariable(qProp)
const result = await doc.createSessionVariable({ "qInfo": { "qId": "value", "qType": "value" }, "qMetaDef": {}, "qName": "value", "qComment": "value", "qNumberPresentation": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qIncludeInBookmark": false, "qDefinition": "value", "qConstraints": { "qType": "any", "qValuesText": [ "value" ], "qValuesNum": [ 123 ] }})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateSessionVariable", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qMetaDef": {}, "qName": "value", "qComment": "value", "qNumberPresentation": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qIncludeInBookmark": false, "qDefinition": "value", "qConstraints": { "qType": "any", "qValuesText": [ "value" ], "qValuesNum": [ 123 ] } } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Create temporary bookmark
Parameters
- qOptions objectRequired
Options for the temporary bookmark
qOptions properties
- qIncludeVariables boolean
IncludeVariables If true all variables will be stored in the temporary bookmark
- qIncludeAllPatches boolean
IncludeAllPatches If true all patches will be stored in the temporary bookmark, if false ObjectIdsToPatch will determine what patches to include
-
- qObjectIdsToPatch array of strings
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.
Response
- qId string
- qReturn boolean
Errors
arrayCreateTemporaryBookmark(qOptions, qObjectIdsToPatch?)
const result = await doc.createTemporaryBookmark({ "qIncludeVariables": true, "qIncludeAllPatches": true}, [ "value"])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateTemporaryBookmark", "params": { "qOptions": { "qIncludeVariables": true, "qIncludeAllPatches": true }, "qObjectIdsToPatch": [ "value" ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qId": "value", "qReturn": true }}Creates a variable.
Parameters
- qName stringRequired
Name of the variable. Variable names are case sensitive.
Response
- qReturn boolean
Errors
arrayCreateVariable(qName)
const result = await doc.createVariable("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateVariable", "params": { "qName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}Creates a variable. To create a variable via a script, you need to use the SetScript method. For more information, see Create a variable.
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
- qProp objectRequired
Name of the variable. Variable names are case sensitive and must be unique.
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
- qName string
Name of the variable. The name must be unique. This parameter is mandatory.
- qComment string
Comment related to the variable. This parameter is optional.
- qNumberPresentation object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberPresentation properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- 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 object
qConstraints properties
- qType string
Can be one of: "any""number""text"
- qValuesText array of strings
- qValuesNum array of numbers
-
-
Response
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qReturn object
qReturn properties
- 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.
-
Errors
arrayCreateVariableEx(qProp)
const result = await doc.createVariableEx({ "qInfo": { "qId": "value", "qType": "value" }, "qMetaDef": {}, "qName": "value", "qComment": "value", "qNumberPresentation": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qIncludeInBookmark": false, "qDefinition": "value", "qConstraints": { "qType": "any", "qValuesText": [ "value" ], "qValuesNum": [ 123 ] }})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "CreateVariableEx", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qMetaDef": {}, "qName": "value", "qComment": "value", "qNumberPresentation": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qIncludeInBookmark": false, "qDefinition": "value", "qConstraints": { "qType": "any", "qValuesText": [ "value" ], "qValuesNum": [ 123 ] } } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfo": { "qId": "value", "qType": "value" }, "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Deletes a connection.
Parameters
- qConnectionId stringRequired
Identifier of the connection to remove.
Response
objectErrors
arrayDeleteConnection(qConnectionId)
const result = await doc.deleteConnection("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DeleteConnection", "params": { "qConnectionId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Removes a bookmark.
Parameters
- qId stringRequired
Identifier of the bookmark.
Response
- qSuccess boolean
Errors
arrayDestroyBookmark(qId)
const result = await doc.destroyBookmark("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroyBookmark", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a dimension.
Parameters
- qId stringRequired
Identifier of the dimension to remove.
Response
- qSuccess boolean
Errors
arrayDestroyDimension(qId)
const result = await doc.destroyDimension("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroyDimension", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}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.
Parameters
- qId stringRequired
Identifier of the draft object to remove.
- qSourceId stringRequired
Identifier of the source object (the object from which a draft was created).
Response
- qSuccess boolean
Errors
arrayDestroyDraft(qId, qSourceId)
const result = await doc.destroyDraft("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroyDraft", "params": { "qId": "value", "qSourceId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a generic measure.
Parameters
- qId stringRequired
Identifier of the measure to remove.
Response
- qSuccess boolean
Errors
arrayDestroyMeasure(qId)
const result = await doc.destroyMeasure("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroyMeasure", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes an app object. The children of the object (if any) are removed as well.
Parameters
- qId stringRequired
Identifier of the object to remove.
Response
- qSuccess boolean
Errors
arrayDestroyObject(qId)
const result = await doc.destroyObject("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroyObject", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a transient object.
Parameters
- qId stringRequired
Identifier of the transient object to remove.
Response
- qSuccess boolean
Errors
arrayDestroySessionObject(qId)
const result = await doc.destroySessionObject("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroySessionObject", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a transient variable.
Parameters
- qId stringRequired
Identifier of the variable.
Response
- qSuccess boolean
Errors
arrayDestroySessionVariable(qId)
const result = await doc.destroySessionVariable("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroySessionVariable", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a transient variable.
Parameters
- qId stringRequired
Identifier of the variable.
Response
- qSuccess boolean
Errors
arrayDestroySessionVariableById(qId)
const result = await doc.destroySessionVariableById("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroySessionVariableById", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a transient variable.
Parameters
- qName stringRequired
Name of the variable.
Response
- qSuccess boolean
Errors
arrayDestroySessionVariableByName(qName)
const result = await doc.destroySessionVariableByName("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroySessionVariableByName", "params": { "qName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a variable. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.
Parameters
- qId stringRequired
Identifier of the variable.
Response
- qSuccess boolean
Errors
arrayDestroyVariableById(qId)
const result = await doc.destroyVariableById("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroyVariableById", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a variable. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.
Parameters
- qName stringRequired
Name of the variable.
Response
- qSuccess boolean
Errors
arrayDestroyVariableByName(qName)
const result = await doc.destroyVariableByName("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DestroyVariableByName", "params": { "qName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}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
- qMode integer
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
Set to true for partial reload. The default value is false.
- qDebug boolean
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.
Response
- qReturn boolean
Errors
arrayDoReload(qMode?, qPartial?, qDebug?)
const result = await doc.doReload(123, true, true)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DoReload", "params": { "qMode": 123, "qPartial": true, "qDebug": true }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}Reloads the script that is set in an app and returns the path to the script log file.
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:
|
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
- qParams object
qParams properties
- qMode integer
- : for default mode.
- : for ABEND; the reload of the script ends if an error occurs.
- : 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
When true, Store statements are skipped. The default value is false.
- qRowLimit integer
If greater than or equal to 0, defines the maximum number of rows loaded from a data source.
-
Response
- qResult object
The result and path to script log for a reload.
qResult properties
- qSuccess boolean
The reload is successful if True.
- qScriptLogFile string
Path to the script log file.
- qEndedWithMemoryConstraint boolean
true if memory limits were exhausted during reload.
- qNbrOfLoadedRows integer
Number of read rows during a reload
- qNbrOfStoredRows integer
Number of stored rows from a reload
- qFailureData object
qFailureData properties
- qErrors array of objects
Array of errors accumulated during reload.
qErrors properties
- qError string
Type of error.
- qDescription string
Description of error.
- qLine string
Script line text where error occurred.
- qLineNumber integer
Script line number where error occurred (zero-based).
- qCode integer
Error code.
- qTitle string
Can be one of: "LOCERR_INTERNAL_ERROR""LOCERR_GENERIC_UNKNOWN""LOCERR_GENERIC_OK""LOCERR_GENERIC_NOT_SET""LOCERR_GENERIC_NOT_FOUND""LOCERR_GENERIC_ALREADY_EXISTS""LOCERR_GENERIC_INVALID_PATH""LOCERR_GENERIC_ACCESS_DENIED""LOCERR_GENERIC_OUT_OF_MEMORY""LOCERR_GENERIC_NOT_INITIALIZED""LOCERR_GENERIC_INVALID_PARAMETERS""LOCERR_GENERIC_EMPTY_PARAMETERS""LOCERR_GENERIC_INTERNAL_ERROR""LOCERR_GENERIC_CORRUPT_DATA""LOCERR_GENERIC_MEMORY_INCONSISTENCY""LOCERR_GENERIC_INVISIBLE_OWNER_ABORT""LOCERR_GENERIC_PROHIBIT_VALIDATE""LOCERR_GENERIC_ABORTED""LOCERR_GENERIC_CONNECTION_LOST""LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION""LOCERR_GENERIC_REST_CONNECTION_FAILURE""LOCERR_GENERIC_MEMORY_LIMIT_REACHED""LOCERR_GENERIC_NOT_IMPLEMENTED""LOCERR_GENERIC_ENGINE_TERMINATED""LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED""LOCERR_HTTP_400""LOCERR_HTTP_401""LOCERR_HTTP_402""LOCERR_HTTP_403""LOCERR_HTTP_404""LOCERR_HTTP_405""LOCERR_HTTP_406""LOCERR_HTTP_407""LOCERR_HTTP_408""LOCERR_HTTP_409""LOCERR_HTTP_410""LOCERR_HTTP_411""LOCERR_HTTP_412""LOCERR_HTTP_413""LOCERR_HTTP_414""LOCERR_HTTP_415""LOCERR_HTTP_416""LOCERR_HTTP_417""LOCERR_HTTP_422""LOCERR_HTTP_423""LOCERR_HTTP_429""LOCERR_HTTP_500""LOCERR_HTTP_501""LOCERR_HTTP_502""LOCERR_HTTP_503""LOCERR_HTTP_504""LOCERR_HTTP_505""LOCERR_HTTP_509""LOCERR_HTTP_COULD_NOT_RESOLVE_HOST""LOCERR_APP_ALREADY_EXISTS""LOCERR_APP_INVALID_NAME""LOCERR_APP_ALREADY_OPEN""LOCERR_APP_NOT_FOUND""LOCERR_APP_IMPORT_FAILED""LOCERR_APP_SAVE_FAILED""LOCERR_APP_CREATE_FAILED""LOCERR_APP_INVALID""LOCERR_APP_CONNECT_FAILED""LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE""LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE""LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION""LOCERR_APP_MIGRATION_FAILURE""LOCERR_APP_SCRIPT_MISSING""LOCERR_APP_EXPORT_FAILED""LOCERR_APP_SIZE_EXCEEDED""LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED""LOCERR_APP_NOT_OPEN""LOCERR_APP_EVENT_SOURCE_TIMEOUT""LOCERR_APP_SOFT_DELETED""LOCERR_CONNECTION_ALREADY_EXISTS""LOCERR_CONNECTION_NOT_FOUND""LOCERR_CONNECTION_FAILED_TO_LOAD""LOCERR_CONNECTION_FAILED_TO_IMPORT""LOCERR_CONNECTION_NAME_IS_INVALID""LOCERR_CONNECTION_MISSING_CREDENTIALS""LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT""LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE""LOCERR_FILE_ACCESS_DENIED""LOCERR_FILE_NAME_INVALID""LOCERR_FILE_CORRUPT""LOCERR_FILE_NOT_FOUND""LOCERR_FILE_FORMAT_UNSUPPORTED""LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE""LOCERR_FILE_TABLE_NOT_FOUND""LOCERR_USER_ACCESS_DENIED""LOCERR_USER_IMPERSONATION_FAILED""LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS""LOCERR_SERVER_OUT_OF_SESSION_CALS""LOCERR_SERVER_OUT_OF_USAGE_CALS""LOCERR_SERVER_OUT_OF_CALS""LOCERR_SERVER_OUT_OF_NAMED_CALS""LOCERR_SERVER_OFF_DUTY""LOCERR_SERVER_BUSY""LOCERR_SERVER_LICENSE_EXPIRED""LOCERR_SERVER_AJAX_DISABLED""LOCERR_SERVER_NO_TOKEN""LOCERR_HC_INVALID_OBJECT""LOCERR_HC_RESULT_TOO_LARGE""LOCERR_HC_INVALID_OBJECT_STATE""LOCERR_HC_MODAL_OBJECT_ERROR""LOCERR_CALC_INVALID_DEF""LOCERR_CALC_NOT_IN_LIB""LOCERR_CALC_HEAP_ERROR""LOCERR_CALC_TOO_LARGE""LOCERR_CALC_TIMEOUT""LOCERR_CALC_EVAL_CONDITION_FAILED""LOCERR_CALC_MIXED_LINKED_AGGREGATION""LOCERR_CALC_MISSING_LINKED""LOCERR_CALC_INVALID_COL_SORT""LOCERR_CALC_PAGES_TOO_LARGE""LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED""LOCERR_CALC_VALIDATION_STATE_INVALID""LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS""LOCERR_CALC_MISSING_LINKED_FIELD""LOCERR_CALC_NOT_CALCULATED""LOCERR_LAYOUT_EXTENDS_INVALID_ID""LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND""LOCERR_LAYOUT_LINKED_OBJECT_INVALID""LOCERR_PERSISTENCE_WRITE_FAILED""LOCERR_PERSISTENCE_READ_FAILED""LOCERR_PERSISTENCE_DELETE_FAILED""LOCERR_PERSISTENCE_NOT_FOUND""LOCERR_PERSISTENCE_UNSUPPORTED_VERSION""LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY""LOCERR_PERSISTENCE_MIGRATION_CANCELLED""LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED""LOCERR_PERSISTENCE_DISK_FULL""LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP""LOCERR_PERSISTENCE_MOVE_FAILED""LOCERR_PERSISTENCE_OBJECT_LOCKED""LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING""LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS""LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS""LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED""LOCERR_RELOAD_IN_PROGRESS""LOCERR_RELOAD_TABLE_X_NOT_FOUND""LOCERR_RELOAD_UNKNOWN_STATEMENT""LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN""LOCERR_RELOAD_FIELD_X_NOT_FOUND""LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND""LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND""LOCERR_RELOAD_NAME_ALREADY_TAKEN""LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF""LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF""LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED""LOCERR_RELOAD_OPEN_FILE_ERROR""LOCERR_RELOAD_AUTO_GENERATE_COUNT""LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB""LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR""LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND""LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID""LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE""LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE""LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS""LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS""LOCERR_RELOAD_NO_OPEN_DATABASE""LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY""LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE""LOCERR_RELOAD_ODBC_CONNECT_FAILED""LOCERR_RELOAD_OLEDB_CONNECT_FAILED""LOCERR_RELOAD_CUSTOM_CONNECT_FAILED""LOCERR_RELOAD_ODBC_READ_FAILED""LOCERR_RELOAD_OLEDB_READ_FAILED""LOCERR_RELOAD_CUSTOM_READ_FAILED""LOCERR_RELOAD_BINARY_LOAD_PROHIBITED""LOCERR_RELOAD_CONNECTOR_START_FAILED""LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING""LOCERR_RELOAD_CONNECTOR_REPLY_ERROR""LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR""LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR""LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS""LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE""LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD""LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT""LOCERR_RELOAD_EXIT_ERROR""LOCERR_PERSONAL_NEW_VERSION_AVAILABLE""LOCERR_PERSONAL_VERSION_EXPIRED""LOCERR_PERSONAL_SECTION_ACCESS_DETECTED""LOCERR_PERSONAL_APP_DELETION_FAILED""LOCERR_USER_AUTHENTICATION_FAILURE""LOCERR_EXPORT_OUT_OF_MEMORY""LOCERR_EXPORT_NO_DATA""LOCERR_SYNC_INVALID_OFFSET""LOCERR_SEARCH_TIMEOUT""LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL""LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW""LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT""LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED""LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED""LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED""LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED""LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED""LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED""LOCERR_SMART_LOAD_TABLE_NOT_FOUND""LOCERR_SMART_LOAD_TABLE_DUPLICATED""LOCERR_VARIABLE_NO_NAME""LOCERR_VARIABLE_DUPLICATE_NAME""LOCERR_VARIABLE_INCONSISTENCY""LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY""LOCERR_VARIABLE_CONSTRAINT_FAILED""LOCERR_MEDIA_LIBRARY_LIST_FAILED""LOCERR_MEDIA_LIBRARY_CONTENT_FAILED""LOCERR_MEDIA_BUNDLING_FAILED""LOCERR_MEDIA_UNBUNDLING_FAILED""LOCERR_MEDIA_LIBRARY_NOT_FOUND""LOCERR_FEATURE_DISABLED""LOCERR_LOAD_TOO_MANY_FIELDS""LOCERR_LOAD_TOO_MANY_TABLES""LOCERR_JSON_RPC_INVALID_REQUEST""LOCERR_JSON_RPC_METHOD_NOT_FOUND""LOCERR_JSON_RPC_INVALID_PARAMETERS""LOCERR_JSON_RPC_INTERNAL_ERROR""LOCERR_JSON_RPC_RESPONSE_TOO_LARGE""LOCERR_JSON_RPC_PARSE_ERROR""LOCERR_MQ_SOCKET_CONNECT_FAILURE""LOCERR_MQ_SOCKET_OPEN_FAILURE""LOCERR_MQ_PROTOCOL_NO_RESPONE""LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION""LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED""LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED""LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR""LOCERR_MQ_PROTOCOL_INVALID_STATUS""LOCERR_EXTENGINE_GRPC_STATUS_OK""LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED""LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN""LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT""LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED""LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND""LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS""LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED""LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED""LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION""LOCERR_EXTENGINE_GRPC_STATUS_ABORTED""LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE""LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED""LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL""LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE""LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS""LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED""LOCERR_LXW_INVALID_OBJ""LOCERR_LXW_INVALID_FILE""LOCERR_LXW_INVALID_SHEET""LOCERR_LXW_INVALID_EXPORT_RANGE""LOCERR_LXW_ERROR""LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED""LOCERR_LXW_ERROR_CREATING_XLSX_FILE""LOCERR_LXW_ERROR_CREATING_TMPFILE""LOCERR_LXW_ERROR_ZIP_FILE_OPERATION""LOCERR_LXW_ERROR_ZIP_FILE_ADD""LOCERR_LXW_ERROR_ZIP_CLOSE""LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED""LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED""LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED""LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND""LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE""LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED""LOCERR_BDI_STATUS_OK""LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED""LOCERR_TRENDLINE_INVALID_DEF""LOCERR_TRENDLINE_INVALID_MATH_ERROR""LOCERR_CURL_UNSUPPORTED_PROTOCOL""LOCERR_CURL_COULDNT_RESOLVE_PROXY""LOCERR_CURL_COULDNT_CONNECT""LOCERR_CURL_REMOTE_ACCESS_DENIED""LOCERR_CURL_FTP_ACCEPT_FAILED""LOCERR_CURL_FTP_ACCEPT_TIMEOUT""LOCERR_CURL_FTP_CANT_GET_HOST""LOCERR_CURL_PARTIAL_FILE""LOCERR_CURL_QUOTE_ERROR""LOCERR_CURL_WRITE_ERROR""LOCERR_CURL_UPLOAD_FAILED""LOCERR_CURL_OUT_OF_MEMORY""LOCERR_CURL_OPERATION_TIMEDOUT""LOCERR_CURL_FTP_COULDNT_USE_REST""LOCERR_CURL_HTTP_POST_ERROR""LOCERR_CURL_SSL_CONNECT_ERROR""LOCERR_CURL_FILE_COULDNT_READ_FILE""LOCERR_CURL_LDAP_CANNOT_BIND""LOCERR_CURL_LDAP_SEARCH_FAILED""LOCERR_CURL_TOO_MANY_REDIRECTS""LOCERR_CURL_PEER_FAILED_VERIFICATION""LOCERR_CURL_GOT_NOTHING""LOCERR_CURL_SSL_ENGINE_NOTFOUND""LOCERR_CURL_SSL_ENGINE_SETFAILED""LOCERR_CURL_SSL_CERTPROBLEM""LOCERR_CURL_SSL_CIPHER""LOCERR_CURL_SSL_CACERT""LOCERR_CURL_BAD_CONTENT_ENCODING""LOCERR_CURL_LDAP_INVALID_URL""LOCERR_CURL_USE_SSL_FAILED""LOCERR_CURL_SSL_ENGINE_INITFAILED""LOCERR_CURL_LOGIN_DENIED""LOCERR_CURL_TFTP_NOTFOUND""LOCERR_CURL_TFTP_ILLEGAL""LOCERR_CURL_SSH""LOCERR_SETEXPRESSION_TOO_LARGE""LOCERR_RELOAD_MERGE_LOAD_ERROR""LOCERR_WIN_FTP_DROPPED""LOCERR_WIN_FTP_NO_PASSIVE_MODE""LOCERR_WIN_HTTP_DOWNLEVEL_SERVER""LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE""LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION""LOCERR_WIN_INTERNET_FORCE_RETRY""LOCERR_WIN_INTERNET_CANNOT_CONNECT""LOCERR_WIN_INTERNET_CONNECTION_ABORTED""LOCERR_WIN_INTERNET_CONNECTION_RESET""LOCERR_WIN_INTERNET_DISCONNECTED""LOCERR_WIN_INTERNET_INCORRECT_FORMAT""LOCERR_WIN_INTERNET_INVALID_CA""LOCERR_WIN_INTERNET_INVALID_OPERATION""LOCERR_WIN_INTERNET_INVALID_URL""LOCERR_WIN_INTERNET_ITEM_NOT_FOUND""LOCERR_WIN_INTERNET_LOGIN_FAILURE""LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED""LOCERR_WIN_INTERNET_NEED_UI""LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID""LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID""LOCERR_WIN_INTERNET_SEC_CERT_ERRORS""LOCERR_WIN_INTERNET_SEC_INVALID_CERT""LOCERR_WIN_INTERNET_SERVER_UNREACHABLE""LOCERR_BM_RESULT_TOO_LARGE"
-
-
-
Errors
arrayDoReloadEx(qParams?)
const result = await doc.doReloadEx({ "qMode": 0, "qPartial": false, "qDebug": false, "qReloadId": "value", "qSkipStore": false, "qRowLimit": -1})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DoReloadEx", "params": { "qParams": { "qMode": 0, "qPartial": false, "qDebug": false, "qReloadId": "value", "qSkipStore": false, "qRowLimit": -1 } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": { "qSuccess": true, "qScriptLogFile": "value", "qEndedWithMemoryConstraint": true, "qNbrOfLoadedRows": 123, "qNbrOfStoredRows": 123, "qFailureData": { "qErrors": [ { "qError": "value", "qDescription": "value", "qLine": "value", "qLineNumber": 123, "qCode": 123, "qTitle": "LOCERR_INTERNAL_ERROR" } ] } } }}Saves an app. All objects and data in the data model are saved.
Parameters
- qFileName string
Name of the file to save.
Response
objectErrors
arrayDoSave(qFileName?)
const result = await doc.doSave("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "DoSave", "params": { "qFileName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}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
- qExpression stringRequired
Expression to evaluate.
Response
- qReturn string
Errors
arrayEvaluate(qExpression)
const result = await doc.evaluate("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Evaluate", "params": { "qExpression": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": "value" }}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
- qExpression stringRequired
Expression to evaluate.
Response
- qValue object
qValue properties
- qText string
Text related to the field value. This parameter is optional.
- qIsNumeric boolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumber number
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
Errors
arrayEvaluateEx(qExpression)
const result = await doc.evaluateEx("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "EvaluateEx", "params": { "qExpression": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qValue": { "qText": "value", "qIsNumeric": true, "qNumber": 123 } }}Expands the expression.
Parameters
- qExpression stringRequired
The expression string to expand.
Response
- qExpandedExpression string
Errors
arrayExpandExpression(qExpression)
const result = await doc.expandExpression("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ExpandExpression", "params": { "qExpression": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qExpandedExpression": "value" }}Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.
Parameters
- qOptions object
BookmarkId used to reduced the app on and an expire time.
qOptions properties
- 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
-
Response
- qDownloadInfo object
qDownloadInfo properties
- qUrl string
URL to download the reduced app on.
- qFileSize integer
The filesize of the reduced app.
-
Errors
arrayExportReducedData(qOptions?)
const result = await doc.exportReducedData({ "qBookmarkId": "value", "qExpires": 3600, "qServeOnce": false})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ExportReducedData", "params": { "qOptions": { "qBookmarkId": "value", "qExpires": 3600, "qServeOnce": false } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qDownloadInfo": { "qUrl": "value", "qFileSize": -1 } }}Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.
Parameters
- qFieldName stringRequired
Name of the field. This method looks for fields that belong to the same archipelago as this specified field.
- qTags array of stringsRequired
List of tags. This method looks for fields that match at least one of the tags in this list.
Response
- qFieldNames array of objects
qFieldNames properties
- qName string
Name of the field.
- qTags array of strings
List of tags.
-
Errors
arrayFindMatchingFields(qFieldName, qTags)
const result = await doc.findMatchingFields("value", [ "value"])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "FindMatchingFields", "params": { "qFieldName": "value", "qTags": [ "value" ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qFieldNames": [ { "qName": "value", "qTags": [ "value" ] } ] }}Forward()
const result = await doc.forward()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Forward"}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Returns the number of entries on the Forward stack.
Response
- qReturn integer
Errors
arrayForwardCount()
const result = await doc.forwardCount()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ForwardCount"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": 123 }}Returns the identifier and the type of any generic object in the app.
Response
- qInfos array of objects
qInfos properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
Errors
arrayGetAllInfos()
const result = await doc.getAllInfos()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetAllInfos"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfos": [ { "qId": "value", "qType": "value" } ] }}Evaluates an app. Returns dynamic properties (if any) in addition to the engine (fixed) properties. A data set is returned.
Response
- qLayout object
Qlik Sense Desktop
In Qlik Sense Desktop, this structure can contain dynamic properties.
Qlik Sense Enterprise
In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted. The persisted dynamic properties are the following:
- modifiedDate
- published
- publishTime
- privileges
- description
- dynamicColor
qLayout properties
- qTitle string
Title of the app.
- qFileName string
In Qlik Sense Enterprise, this property corresponds to the app identifier (GUID). In Qlik Sense Desktop, this property corresponds to the full path of the app.
- qLastReloadTime string
Date and time of the last reload of the app in ISO format.
- qModified boolean
Is set to true if the app has been updated since the last save.
- qHasScript boolean
Is set to true if a script is defined in the app.
- qStateNames array of strings
Array of alternate states.
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qLocaleInfo object
qLocaleInfo properties
- qDecimalSep string
Decimal separator.
- qThousandSep string
Thousand separator.
- qListSep string
List separator.
- qMoneyDecimalSep string
Money decimal separator.
- qMoneyThousandSep string
Money thousand separator.
- qCurrentYear integer
Current year.
- qMoneyFmt string
Money format. Example: #.##0,00 kr;-#.##0,00 kr
- qTimeFmt string
Time format. Example: hh:mm:ss
- qDateFmt string
Date format. Example: YYYY-MM-DD
- qTimestampFmt string
Time stamp format. Example: YYYY-MM-DD hh:mm:ss[.fff]
- qCalendarStrings object
qCalendarStrings properties
- qDayNames array of strings
List of short day names.
- qMonthNames array of strings
List of short month names.
- qLongDayNames array of strings
List of long day names.
- qLongMonthNames array of strings
List of long month names.
-
- qFirstWeekDay integer
First day of the week, starting from 0. According to ISO 8601, Monday is the first day of the week.
- 0 = Monday
- 1 = Tuesday
- ...
- 6 = Sunday
If this property has not been set in a script, the returned value comes from the Windows operating system.
- 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
-
- qHasData boolean
Is set to true if the app contains data following a script reload.
- qReadOnly boolean
If set to true, it means that the app is read-only.
- qIsOpenedWithoutData boolean
If set to true, it means that the app was opened without loading its data.
- qIsSessionApp boolean
If set to true, the app is a Session App, i.e. not persistent.
- qProhibitBinaryLoad boolean
When true, the persisted app cannot be used in a Binary load statement in a Qlik load script.
- qThumbnail objectIn addition, this structure can return dynamic properties.
qThumbnail properties
- qUrl string
Relative path of the thumbnail.
-
- qIsBDILiveMode boolean
If set to true, the app is in BDI Direct Query Mode.
- qIsDirectQueryMode boolean
If set to true, the app is in Direct Query Mode.
- qUnsupportedFeatures array of strings
Array of features not supported by the app.
Values may be any of: "binningData""bookmarks""calculatedFields""continuousData""invertedSelections""rangeSelections""reducingData""search""selectionCount""selectionInsights""tableMiniChart""trendlines""calculatedDimensions""includeZeroValues""includeNullValues""filterPanePaging""filterPaneCustomSorting""showFrequency""limitation""totals"
- qUsage string
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
Errors
arrayGetAppLayout()
const result = await doc.getAppLayout()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetAppLayout"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qLayout": { "qTitle": "value", "qFileName": "value", "qLastReloadTime": "value", "qModified": true, "qHasScript": true, "qStateNames": [ "value" ], "qMeta": { "qName": "value" }, "qLocaleInfo": { "qDecimalSep": "value", "qThousandSep": "value", "qListSep": "value", "qMoneyDecimalSep": "value", "qMoneyThousandSep": "value", "qCurrentYear": 123, "qMoneyFmt": "value", "qTimeFmt": "value", "qDateFmt": "value", "qTimestampFmt": "value", "qCalendarStrings": { "qDayNames": [ "value" ], "qMonthNames": [ "value" ], "qLongDayNames": [ "value" ], "qLongMonthNames": [ "value" ] }, "qFirstWeekDay": 123, "qBrokenWeeks": true, "qReferenceDay": 123, "qFirstMonthOfYear": 123, "qCollation": "value", "qNumericalAbbreviation": "value" }, "qHasData": true, "qReadOnly": true, "qIsOpenedWithoutData": true, "qIsSessionApp": true, "qProhibitBinaryLoad": true, "qThumbnail": { "qUrl": "value" }, "qIsBDILiveMode": true, "qIsDirectQueryMode": true, "qUnsupportedFeatures": [ "binningData" ], "qUsage": "ANALYTICS" } }}Gets the properties of an app.
Response
- qProp object
Qlik Sense Desktop
In Qlik Sense Desktop, this structure can contain dynamic properties.
Qlik Sense Enterprise
In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted. The persisted dynamic properties are the following:
- modifiedDate
- published
- publishTime
- privileges
- description
- dynamicColor
qProp properties
- qTitle string
App title.
- qLastReloadTime string
Last reload time of the app.
- qMigrationHash string
Internal property reserved for app migration. Patch version of the app. Do not update.
- qSavedInProductVersion string
Internal property reserved for app migration. The app is saved in this version of the product. Do not update.
- qThumbnail objectIn addition, this structure can contain dynamic properties.
qThumbnail properties
- qUrl string
Relative path of the thumbnail.
-
- qHasSectionAccess boolean
If true the app has section access configured.
- qUsage string
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
Errors
arrayGetAppProperties()
const result = await doc.getAppProperties()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetAppProperties"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qProp": { "qTitle": "value", "qLastReloadTime": "value", "qMigrationHash": "value", "qSavedInProductVersion": "value", "qThumbnail": { "qUrl": "value" }, "qHasSectionAccess": true, "qUsage": "ANALYTICS" } }}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
- qTable1 stringRequired
Name of the first table.
- qTable2 stringRequired
Name of the second table.
Response
- qScore array of objects
qScore properties
- qFieldPairName string
Pair of fields. < FieldName1> / < FieldName2> Where: < FieldName1 > is a field in the table 1 (defined in qTable1 ) < FieldName2 > is a field in the table 2 (defined in qTable2 ) If the field is a synthetic key, the name of the field is preceded by [Synthetic key]: .
- qScoreSummary integer
Flag used to interpret calculated scores. One of the following values or sum of values that apply:
- 0: The cardinal ratio cannot be zero but the symbol score and the row score can be zero.
- -1: The fields do not have the same type.
- -2: The number of rows of the field FieldName1 is zero.
- -4: The number of distinct values of the field FieldName1 is zero.
- -8: The number of rows of the field FieldName2 is zero.
- -16: The number of distinct values of the field FieldName2 is zero.
Example: The number of rows of the field FieldName1 is zero, and the number of distinct values of the field FieldName2 is zero, then qScoreSummary is -18.
- qField1Scores object
qField1Scores properties
- qFieldName string
Field name. One of the field names defined in qFieldPairName.
- qReadableName string
- qCardinalRatio number
Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key.
- 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 .
-
- qField2Scores object
qField2Scores properties
- qFieldName string
Field name. One of the field names defined in qFieldPairName.
- qReadableName string
- qCardinalRatio number
Cardinality of a column/field divided by the number of rows in the table. If the cardinal ratio is 1, it means that the column is a candidate/primary key.
- 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 .
-
-
Errors
arrayGetAssociationScores(qTable1, qTable2)
const result = await doc.getAssociationScores("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetAssociationScores", "params": { "qTable1": "value", "qTable2": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qScore": [ { "qFieldPairName": "value", "qScoreSummary": 123, "qField1Scores": { "qFieldName": "value", "qReadableName": "value", "qCardinalRatio": 123, "qSymbolScore": 123, "qRowScore": 123 }, "qField2Scores": { "qFieldName": "value", "qReadableName": "value", "qCardinalRatio": 123, "qSymbolScore": 123, "qRowScore": 123 } } ] }}Returns the handle of a bookmark.
Parameters
- qId stringRequired
Identifier of the bookmark.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetBookmark(qId)
const result = await doc.getBookmark("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetBookmark", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Returns all bookmarks compatible with options.
Parameters
- qOptions objectRequired
Bookmark type filter and requested properties.
qOptions properties
- qTypes array of strings
List of object types.
- qData object
Contains dynamic JSON data specified by the client.
- qIncludePatches boolean
Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
-
Response
- qList array of objects
qList properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qData object
Contains dynamic JSON data specified by the client.
-
Errors
arrayGetBookmarks(qOptions)
const result = await doc.getBookmarks({ "qTypes": [ "value" ], "qData": {}, "qIncludePatches": true})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetBookmarks", "params": { "qOptions": { "qTypes": [ "value" ], "qData": {}, "qIncludePatches": true } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qList": [ { "qInfo": { "qId": "value", "qType": "value" }, "qMeta": { "qName": "value" }, "qData": {} } ] }}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
- qConnectionId stringRequired
Identifier of the connection.
Response
- qConnection object
qConnection properties
- qId string
Identifier of the connection. Is generated by the engine and is unique.
- qName string
Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection.
- qConnectionString string
One of:
- ODBC CONNECT TO [<provider name>]
- OLEDB CONNECT TO [<provider name>]
- CUSTOM CONNECT TO [<provider name>]
- "<local absolute or relative path, UNC path>"
- "<URL>"
Connection string. This parameter is mandatory and must be set when creating or modifying a connection.
- qType string
One of:
- ODBC
- OLEDB
- <Name of the custom connection file>
- folder
- internet
Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive.
- qUserName string
Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the user name.
- qPassword string
Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the password.
- qModifiedDate string
Is generated by the engine. Creation date of the connection or last modification date of the connection.
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qLogOn string
Can be one of: "LOG_ON_SERVICE_USER""LOG_ON_CURRENT_USER"
-
Errors
arrayGetConnection(qConnectionId)
const result = await doc.getConnection("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetConnection", "params": { "qConnectionId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qConnection": { "qId": "value", "qName": "value", "qConnectionString": "value", "qType": "value", "qUserName": "value", "qPassword": "value", "qModifiedDate": "value", "qMeta": { "qName": "value" }, "qLogOn": "LOG_ON_SERVICE_USER" } }}Lists the connections in an app.
Response
- qConnections array of objects
qConnections properties
- qId string
Identifier of the connection. Is generated by the engine and is unique.
- qName string
Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection.
- qConnectionString string
One of:
- ODBC CONNECT TO [<provider name>]
- OLEDB CONNECT TO [<provider name>]
- CUSTOM CONNECT TO [<provider name>]
- "<local absolute or relative path, UNC path>"
- "<URL>"
Connection string. This parameter is mandatory and must be set when creating or modifying a connection.
- qType string
One of:
- ODBC
- OLEDB
- <Name of the custom connection file>
- folder
- internet
Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive.
- qUserName string
Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the user name.
- qPassword string
Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the password.
- qModifiedDate string
Is generated by the engine. Creation date of the connection or last modification date of the connection.
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qLogOn string
Can be one of: "LOG_ON_SERVICE_USER""LOG_ON_CURRENT_USER"
-
Errors
arrayGetConnections()
const result = await doc.getConnections()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetConnections"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qConnections": [ { "qId": "value", "qName": "value", "qConnectionString": "value", "qType": "value", "qUserName": "value", "qPassword": "value", "qModifiedDate": "value", "qMeta": { "qName": "value" }, "qLogOn": "LOG_ON_SERVICE_USER" } ] }}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.
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.
Response
- qList object
qList properties
- qItems array of objects
Information about the content library.
qItems properties
- qName string
Name of the library.
- qAppSpecific boolean
Is set to true if the library is specific to the app (not a global content library).
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
-
-
Errors
arrayGetContentLibraries()
const result = await doc.getContentLibraries()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetContentLibraries"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qList": { "qItems": [ { "qName": "value", "qAppSpecific": true, "qMeta": { "qName": "value" } } ] } }}Gives information about an ODBC, OLEDB or CUSTOM connection. See Outputs for more details.
Parameters
- qConnectionId stringRequired
Name of the connection.
Response
- qInfo object
qInfo properties
- qDBMSName string
Name of the product accessed by the provider.
- qDBUsage boolean
If set to true, it means that the data source contains some databases.
- qOwnerUsage boolean
If set to true, it means that the data source contains some owners.
- qDBSeparator string
Character string used after the database name. Example with separator " . ": FROM LinkedTablesData.dbo.Months Where:
- LinkedTablesData is the database name
- dbo is the owner name
- Months is the table name
- qOwnerSeparator string
Character string used after the owner name. Example with separator " . ": FROM LinkedTablesData.dbo.Months Where:
- LinkedTablesData is the database name
- dbo is the owner name
- Months is the table name
- qDBFirst boolean
If set to true, it means that the database is displayed first, before the owners and tables.
- qQuotePreffix string
Prefix used with field, database or owner names that contain special characters or keywords.
- qQuoteSuffix string
Suffix used with field, database or owner names that contain special characters or keywords.
- qSpecialChars string
List of the special characters.
- qDefaultDatabase string
Name of the default database.
- qKeywords array of strings
List of the script keywords.
-
Errors
arrayGetDatabaseInfo(qConnectionId)
const result = await doc.getDatabaseInfo("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetDatabaseInfo", "params": { "qConnectionId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfo": { "qDBMSName": "value", "qDBUsage": true, "qOwnerUsage": true, "qDBSeparator": "value", "qOwnerSeparator": "value", "qDBFirst": true, "qQuotePreffix": "value", "qQuoteSuffix": "value", "qSpecialChars": "value", "qDefaultDatabase": "value", "qKeywords": [ "value" ] } }}Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qDatabase string
Name of the database.
Response
- qOwners array of objects
qOwners properties
- qName string
Name of the owner.
-
Errors
arrayGetDatabaseOwners(qConnectionId, qDatabase?)
const result = await doc.getDatabaseOwners("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetDatabaseOwners", "params": { "qConnectionId": "value", "qDatabase": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qOwners": [ { "qName": "value" } ] }}Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qDatabase string
Name of the database. If qDatabase is not set then qOwner must be set.
- qOwner string
Owner of the database. If qOwner is not set then qDatabase must be set.
- qTable stringRequired
Name of the table.
Response
- qFields array of objects
qFields properties
- 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.
-
Errors
arrayGetDatabaseTableFields(qConnectionId, qDatabase?, qOwner?, qTable)
const result = await doc.getDatabaseTableFields("value", "value", "value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetDatabaseTableFields", "params": { "qConnectionId": "value", "qDatabase": "value", "qOwner": "value", "qTable": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qFields": [ { "qName": "value", "qIsKey": false, "qOriginalFieldName": "value" } ] }}Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qDatabase string
Name of the database. If qDatabase is not set then qOwner must be set.
- qOwner string
Owner of the database. If qOwner is not set then qDatabase must be set.
- qTable stringRequired
Name of the table.
- qConditions object
qConditions properties
- qType string
Can be one of: "NONE""RAW"
- qWherePredicate string
-
Response
- qPreview array of objects
qPreview properties
- qValues array of strings
List of values inside the table. The first values (in result/qPreview/0/qValues ) correspond to the field names in the table. The following values (from result/qPreview/1/qValues ) are the values of the fields in the table.
-
- qRowCount integer
Errors
arrayGetDatabaseTablePreview(qConnectionId, qDatabase?, qOwner?, qTable, qConditions?)
const result = await doc.getDatabaseTablePreview("value", "value", "value", "value", { "qType": "NONE", "qWherePredicate": "value"})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetDatabaseTablePreview", "params": { "qConnectionId": "value", "qDatabase": "value", "qOwner": "value", "qTable": "value", "qConditions": { "qType": "NONE", "qWherePredicate": "value" } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qPreview": [ { "qValues": [ "value" ] } ], "qRowCount": 123 }}Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qDatabase string
Name of the database. If qDatabase is not set then qOwner must be set.
- qOwner string
Owner of the database. If qOwner is not set then qDatabase must be set.
Response
- qTables array of objects
qTables properties
- qName string
Name of the table.
- qType string
Type of the table. For example: Table or View.
- qLogicalName string
Logical name of the table. Used by nested Parquet tables.
-
Errors
arrayGetDatabaseTables(qConnectionId, qDatabase?, qOwner?)
const result = await doc.getDatabaseTables("value", "value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetDatabaseTables", "params": { "qConnectionId": "value", "qDatabase": "value", "qOwner": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qTables": [ { "qName": "value", "qType": "value", "qLogicalName": "value" } ] }}Lists the databases inside a ODBC, OLEDB or CUSTOM data source.
Parameters
- qConnectionId stringRequired
Identifier of the connection.
Response
- qDatabases array of objects
qDatabases properties
- qName string
Name of the database.
- qIsDefault boolean
Is set to true if the database is set by default.
-
Errors
arrayGetDatabases(qConnectionId)
const result = await doc.getDatabases("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetDatabases", "params": { "qConnectionId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qDatabases": [ { "qName": "value", "qIsDefault": true } ] }}Returns the handle of a dimension.
Parameters
- qId stringRequired
Identifier of the dimension.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetDimension(qId)
const result = await doc.getDimension("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetDimension", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Creates a script that contains one section. This section contains SET statements that give localized information from the regional settings of the computer.
Parameters
- qLocalizedMainSection string
Name of the script section. The default value is Main .
Response
- qReturn string
Errors
arrayGetEmptyScript(qLocalizedMainSection?)
const result = await doc.getEmptyScript("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetEmptyScript", "params": { "qLocalizedMainSection": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": "value" }}Gets the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.
Response
- qBnfDefs array of objects
qBnfDefs properties
- qBnf array of integers
Array of token references that all together build up the definition of the current token. Generally, if the array is not empty, the definition is a BNF rule (qIsBnfRule is set to true). However, some BNF rules do have an empty array (qIsBnfRule is set to true, but qBnf is empty).
- qNbr integer
Number of the current token definition.
- 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 string
Can be one of: "ALL""U""NONE""AGGR""NUM""RNG""EXP""TRIG""FIN""MATH""COUNT""STR""MAPP""RCRD""CND""LOG""NULL""SYS""FILE""TBL""DATE""NUMI""FRMT""CLR""RNK""GEO""EXT""PROB""ARRAY""LEG""DB""WINDOW"
- qFieldFlag boolean
If set to true, the definition is related to a field. This parameter is optional. The default value is false.
- qMT string
Can be one of: "N""D""R""V"
- qDepr boolean
Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use). If set to true, the script statement or the function is not recommended for use in Qlik Sense. This parameter is optional. The default value is false.
- qFGList array of strings
List of groups the function belongs to.
Values may be any of: "ALL""U""NONE""AGGR""NUM""RNG""EXP""TRIG""FIN""MATH""COUNT""STR""MAPP""RCRD""CND""LOG""NULL""SYS""FILE""TBL""DATE""NUMI""FRMT""CLR""RNK""GEO""EXT""PROB""ARRAY""LEG""DB""WINDOW"
-
- qBnfHash string
Errors
arrayGetExpressionBNF()
const result = await doc.getExpressionBNF()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetExpressionBNF"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qBnfDefs": [ { "qBnf": [ 123 ], "qNbr": 123, "qPNbr": 123, "qHelpId": 123, "qName": "value", "qStr": "value", "qIsBnfRule": false, "qScriptStatement": false, "qControlStatement": false, "qBnfLiteral": false, "qQvFunc": false, "qAggrFunc": false, "qFG": "ALL", "qFieldFlag": false, "qMT": "N", "qDepr": false, "qFGList": [ "ALL" ] } ], "qBnfHash": "value" }}Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.
Response
- qBnfHash string
Errors
arrayGetExpressionBNFHash()
const result = await doc.getExpressionBNFHash()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetExpressionBNFHash"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qBnfHash": "value" }}Retrieves the variables that are tagged as favorite.
Response
- qNames array of strings
Errors
arrayGetFavoriteVariables()
const result = await doc.getFavoriteVariables()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFavoriteVariables"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qNames": [ "value" ] }}Returns a handle to a field.
Parameters
- qFieldName stringRequired
Name of the field.
- qStateName string
Name of the alternate state. Default state is current selections.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetField(qFieldName, qStateName?)
const result = await doc.getField("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetField", "params": { "qFieldName": "value", "qStateName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}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
- qFieldsOrColumnsWithWildcards array of objectsRequired
Pairs of table (optionally) and field names. Support wildcard matches.
qFieldsOrColumnsWithWildcards properties
- qFieldName string
Name of the field or column to be matched.
- qTableName string
Name of the table to be matched on. This parameter is optional. If TableName is set, FieldName represent the Table column with that name. If TableName is not set, FieldName represents the the field with that name.
-
- qMaxNumberOfValues integerRequired
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
Optional. Sets the random number seed. Should only be set for test purposes.
Response
- qResult array of objects
qResult properties
- qFieldOrColumn object
qFieldOrColumn properties
- qFieldName string
Name of the field or column to be matched.
- qTableName string
Name of the table to be matched on. This parameter is optional. If TableName is set, FieldName represent the Table column with that name. If TableName is not set, FieldName represents the the field with that name.
-
- qValues array of objects
Matched values part of the sample.
qValues properties
- qText string
Text related to the field value. This parameter is optional.
- qIsNumeric boolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumber number
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
-
Errors
arrayGetFieldAndColumnSamples(qFieldsOrColumnsWithWildcards, qMaxNumberOfValues, qRandSeed?)
const result = await doc.getFieldAndColumnSamples([ { "qFieldName": "value", "qTableName": "value" }], 123, 123)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFieldAndColumnSamples", "params": { "qFieldsOrColumnsWithWildcards": [ { "qFieldName": "value", "qTableName": "value" } ], "qMaxNumberOfValues": 123, "qRandSeed": 123 }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": [ { "qFieldOrColumn": { "qFieldName": "value", "qTableName": "value" }, "qValues": [ { "qText": "value", "qIsNumeric": true, "qNumber": 123 } ] } ] }}Returns the description of a field.
Parameters
- qFieldName stringRequired
Name of the field.
Response
- qReturn object
qReturn properties
- qInternalNumber integer
Internal number of the field.
- qName string
Name of the field.
- qSrcTables array of strings
List of table names.
- qIsSystem boolean
If set to true, it means that the field is a system field. The default value is false.
- qIsHidden boolean
If set to true, it means that the field is hidden. The default value is false.
- qIsSemantic boolean
If set to true, it means that the field is a semantic. The default value is false.
- qDistinctOnly boolean
If set to true, only distinct field values are shown. The default value is false.
- qCardinal integer
Number of distinct field values.
- 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 strings
Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.
- qIsDefinitionOnly boolean
If set to true, it means that the field is a field on the fly. The default value is false.
- qByteSize integer
Static RAM memory used in bytes.
-
Errors
arrayGetFieldDescription(qFieldName)
const result = await doc.getFieldDescription("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFieldDescription", "params": { "qFieldName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qInternalNumber": 123, "qName": "value", "qSrcTables": [ "value" ], "qIsSystem": true, "qIsHidden": true, "qIsSemantic": true, "qDistinctOnly": true, "qCardinal": 123, "qTotalCount": 123, "qPossibleCount_OBSOLETE": 123, "qHasInfo_OBSOLETE": true, "qIsLocked": true, "qAlwaysOneSelected": true, "qAndMode": true, "qIsNumeric": true, "qComment": "value", "qTags": [ "value" ], "qIsDefinitionOnly": true, "qByteSize": 123 } }}Find the field-on-the-fly by passing its readable name.
Parameters
- qReadableName stringRequired
Readable name of the field-on-the-fly.
Response
- qName string
Errors
arrayGetFieldOnTheFlyByName(qReadableName)
const result = await doc.getFieldOnTheFlyByName("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFieldOnTheFlyByName", "params": { "qReadableName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qName": "value" }}Retrives any fields from an expression.
Parameters
- qExpr stringRequired
Expression to get fields from.
Response
- qFieldNames array of strings
Errors
arrayGetFieldsFromExpression(qExpr)
const result = await doc.getFieldsFromExpression("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFieldsFromExpression", "params": { "qExpr": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qFieldNames": [ "value" ] }}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.
Parameters
- qFieldNames array of stringsRequired
List of fields names that resource ids should be returned from.
Response
- qFields array of objects
qFields properties
- qName string
Name of the field to get the resource id for.
- qResourceIds array of objects
Field level resource Id per table that the field is part of
qResourceIds properties
- qTable string
Name of the table that the field belongs to get the resource id for
- qResourceId string
Resource identifier for the field
-
-
Errors
arrayGetFieldsResourceIds(qFieldNames)
const result = await doc.getFieldsResourceIds([ "value"])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFieldsResourceIds", "params": { "qFieldNames": [ "value" ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qFields": [ { "qName": "value", "qResourceIds": [ { "qTable": "value", "qResourceId": "value" } ] } ] }}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
- GOOGLE_SHEET for Google Sheet file
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qRelativePath string
Path of the connection file.
- qDataFormat objectRequired
Type of the file.
qDataFormat properties
- qType string
Can be one of: "CSV""FIX""DIF""EXCEL_BIFF""EXCEL_OOXML""HTML""QVD""XML""QVX""JSON""KML""PARQUET""GOOGLE_SHEET"
- qLabel string
One of:
- Embedded labels (field names are present in the file)
- No labels
- Explicit labels (for DIFfiles)
- qQuote string
One of:
- None (no quotes)
- MSQ (Modern Style Quoting)
- Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value)
This property is used for delimited files.
- qComment string
String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files.
- qDelimiter object
qDelimiter properties
- qName string
Name of the delimiter. Example: "Tab_DELIMITER"
- qScriptCode string
Representation of the delimiter value that is used in the script. Example: "'\t'"
- qNumber integer
Delimiter character number used by the engine to determine how to separate the values.
- qIsMultiple boolean
Is set to true if multiple spaces are used to separate the values.
-
- 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.
-
- qTable stringRequired
Name of the table. This parameter must be set for XLS , XLSX , _HTML _ and XML files.
Response
- qFields array of objects
qFields properties
- 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.
-
- qFormatSpec string
Errors
arrayGetFileTableFields(qConnectionId, qRelativePath?, qDataFormat, qTable)
const result = await doc.getFileTableFields("value", "value", { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value"}, "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFileTableFields", "params": { "qConnectionId": "value", "qRelativePath": "value", "qDataFormat": { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value" }, "qTable": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qFields": [ { "qName": "value", "qIsKey": false, "qOriginalFieldName": "value" } ], "qFormatSpec": "value" }}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
- GOOGLE_SHEET for Google Sheet file
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qRelativePath string
Path of the connection file.
- qDataFormat objectRequired
Type of the file.
qDataFormat properties
- qType string
Can be one of: "CSV""FIX""DIF""EXCEL_BIFF""EXCEL_OOXML""HTML""QVD""XML""QVX""JSON""KML""PARQUET""GOOGLE_SHEET"
- qLabel string
One of:
- Embedded labels (field names are present in the file)
- No labels
- Explicit labels (for DIFfiles)
- qQuote string
One of:
- None (no quotes)
- MSQ (Modern Style Quoting)
- Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value)
This property is used for delimited files.
- qComment string
String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files.
- qDelimiter object
qDelimiter properties
- qName string
Name of the delimiter. Example: "Tab_DELIMITER"
- qScriptCode string
Representation of the delimiter value that is used in the script. Example: "'\t'"
- qNumber integer
Delimiter character number used by the engine to determine how to separate the values.
- qIsMultiple boolean
Is set to true if multiple spaces are used to separate the values.
-
- 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.
-
- qTable stringRequired
Name of the table. This parameter must be set for XLS , XLSX , _HTML _ and XML files.
Response
- qPreview array of objects
qPreview properties
- qValues array of strings
List of values inside the table. The first values (in result/qPreview/0/qValues ) correspond to the field names in the table. The following values (from result/qPreview/1/qValues ) are the values of the fields in the table.
-
- qFormatSpec string
Errors
arrayGetFileTablePreview(qConnectionId, qRelativePath?, qDataFormat, qTable)
const result = await doc.getFileTablePreview("value", "value", { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value"}, "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFileTablePreview", "params": { "qConnectionId": "value", "qRelativePath": "value", "qDataFormat": { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value" }, "qTable": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qPreview": [ { "qValues": [ "value" ] } ], "qFormatSpec": "value" }}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
- GOOGLE_SHEET for Google Sheet file
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qRelativePath string
Path of the connection file.
- qDataFormat objectRequired
Type of the file.
qDataFormat properties
- qType string
Can be one of: "CSV""FIX""DIF""EXCEL_BIFF""EXCEL_OOXML""HTML""QVD""XML""QVX""JSON""KML""PARQUET""GOOGLE_SHEET"
- qLabel string
One of:
- Embedded labels (field names are present in the file)
- No labels
- Explicit labels (for DIFfiles)
- qQuote string
One of:
- None (no quotes)
- MSQ (Modern Style Quoting)
- Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value)
This property is used for delimited files.
- qComment string
String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files.
- qDelimiter object
qDelimiter properties
- qName string
Name of the delimiter. Example: "Tab_DELIMITER"
- qScriptCode string
Representation of the delimiter value that is used in the script. Example: "'\t'"
- qNumber integer
Delimiter character number used by the engine to determine how to separate the values.
- qIsMultiple boolean
Is set to true if multiple spaces are used to separate the values.
-
- 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.
-
Response
- qTables array of objects
qTables properties
- qName string
Name of the table.
- qType string
Type of the table. For example: Table or View.
- qLogicalName string
Logical name of the table. Used by nested Parquet tables.
-
Errors
arrayGetFileTables(qConnectionId, qRelativePath?, qDataFormat)
const result = await doc.getFileTables("value", "value", { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value"})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFileTables", "params": { "qConnectionId": "value", "qRelativePath": "value", "qDataFormat": { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value" } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qTables": [ { "qName": "value", "qType": "value", "qLogicalName": "value" } ] }}Lists the tables and fields of a JSON or XML file for a folder connection.
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qRelativePath string
Path of the connection file.
- qDataFormat objectRequired
Type of the file.
qDataFormat properties
- qType string
Can be one of: "CSV""FIX""DIF""EXCEL_BIFF""EXCEL_OOXML""HTML""QVD""XML""QVX""JSON""KML""PARQUET""GOOGLE_SHEET"
- qLabel string
One of:
- Embedded labels (field names are present in the file)
- No labels
- Explicit labels (for DIFfiles)
- qQuote string
One of:
- None (no quotes)
- MSQ (Modern Style Quoting)
- Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value)
This property is used for delimited files.
- qComment string
String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files.
- qDelimiter object
qDelimiter properties
- qName string
Name of the delimiter. Example: "Tab_DELIMITER"
- qScriptCode string
Representation of the delimiter value that is used in the script. Example: "'\t'"
- qNumber integer
Delimiter character number used by the engine to determine how to separate the values.
- qIsMultiple boolean
Is set to true if multiple spaces are used to separate the values.
-
- 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.
-
Response
- qTables array of objects
qTables properties
- qName string
Name of the table.
- qFields array of objects
List of the fields in the table.
qFields properties
- 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.
-
- qFormatSpec string
List of format specification items, within brackets. Examples of specification items:
- file type
- embedded labels, no labels
- table is <table name>
- qLogicalName string
Logical name of the table. Used by nested Parquet tables.
-
Errors
arrayGetFileTablesEx(qConnectionId, qRelativePath?, qDataFormat)
const result = await doc.getFileTablesEx("value", "value", { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value"})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFileTablesEx", "params": { "qConnectionId": "value", "qRelativePath": "value", "qDataFormat": { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value" } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qTables": [ { "qName": "value", "qFields": [ { "qName": "value", "qIsKey": false, "qOriginalFieldName": "value" } ], "qFormatSpec": "value", "qLogicalName": "value" } ] }}Lists the items for a folder connection.
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qRelativePath string
Relative path of the connection.
Response
- qFolderItems array of objects
qFolderItems properties
- qName string
Name of the folder item.
- qType string
Can be one of: "FOLDER""FILE""OTHER"
-
Errors
arrayGetFolderItemsForConnection(qConnectionId, qRelativePath?)
const result = await doc.getFolderItemsForConnection("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetFolderItemsForConnection", "params": { "qConnectionId": "value", "qRelativePath": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qFolderItems": [ { "qName": "value", "qType": "FOLDER" } ] }}Response
- qGroupStates array of objectsExperimental
qGroupStates properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qActiveFieldDef string
String defining the active field.
-
Errors
arrayGetGroupStates()
const result = await doc.getGroupStates()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetGroupStates"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qGroupStates": [ { "qInfo": { "qId": "value", "qType": "value" }, "qActiveFieldDef": "value" } ] }}Gets the content of a file.
Parameters
- qPath stringRequired
["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.
Response
- qContent string
Errors
arrayGetIncludeFileContent(qPath)
const result = await doc.getIncludeFileContent("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetIncludeFileContent", "params": { "qPath": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qContent": "value" }}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
- qName stringRequired
Name of the content library. It corresponds to the property qContentLibraryListItem/qName returned by the GetContentLibraries method.
Response
- qList object
qList properties
- qItems array of objects
Information about the list of content files.
qItems properties
- qUrlDef string
Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located:
- In the /content/ <content library name>/ folder are part of a global content library.
- In the /appcontent/ folder are part of the app specific library. The content files are never embedded in the qvf file. In Qlik Sense Desktop, content files located:
- In the /content/default/ folder are outside the qvf file.
- In the /media/ folder are embedded in the qvf file.
- qUrl string
Relative path to the content file. The URL is static. In Qlik Sense Enterprise, content files located:
- In the /content/ <content library name>/ folder are part of a global content library.
- In the /appcontent/ folder are part of the app specific library. The content files are never embedded in the qvf file. In Qlik Sense Desktop, content files located:
- In the /content/default/ folder are outside the qvf file.
- In the /media/ folder are embedded in the qvf file.
-
-
Errors
arrayGetLibraryContent(qName)
const result = await doc.getLibraryContent("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetLibraryContent", "params": { "qName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qList": { "qItems": [ { "qUrlDef": "value", "qUrl": "value" } ] } }}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.
Response
- qLineage array of objects
qLineage properties
- qDiscriminator string
A string indicating the origin of the data:
- [filename]: the data comes from a local file.
- INLINE: the data is entered inline in the load script.
- RESIDENT: the data comes from a resident table. The table name is listed.
- AUTOGENERATE: the data is generated from the load script (no external table of data source).
- Provider: the data comes from a data connection. The connector source name is listed.
- [webfile]: the data comes from a web-based file.
- STORE: path to QVD or TXT file where data is stored.
- EXTENSION: the data comes from a Server Side Extension (SSE).
- qStatement string
The LOAD and SELECT script statements from the data load script.
-
Errors
arrayGetLineage()
const result = await doc.getLineage()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetLineage"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qLineage": [ { "qDiscriminator": "value", "qStatement": "value" } ] }}Returns locale information.
Response
- qReturn object
qReturn properties
- qDecimalSep string
Decimal separator.
- qThousandSep string
Thousand separator.
- qListSep string
List separator.
- qMoneyDecimalSep string
Money decimal separator.
- qMoneyThousandSep string
Money thousand separator.
- qCurrentYear integer
Current year.
- qMoneyFmt string
Money format. Example: #.##0,00 kr;-#.##0,00 kr
- qTimeFmt string
Time format. Example: hh:mm:ss
- qDateFmt string
Date format. Example: YYYY-MM-DD
- qTimestampFmt string
Time stamp format. Example: YYYY-MM-DD hh:mm:ss[.fff]
- qCalendarStrings object
qCalendarStrings properties
- qDayNames array of strings
List of short day names.
- qMonthNames array of strings
List of short month names.
- qLongDayNames array of strings
List of long day names.
- qLongMonthNames array of strings
List of long month names.
-
- qFirstWeekDay integer
First day of the week, starting from 0. According to ISO 8601, Monday is the first day of the week.
- 0 = Monday
- 1 = Tuesday
- ...
- 6 = Sunday
If this property has not been set in a script, the returned value comes from the Windows operating system.
- 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
-
Errors
arrayGetLocaleInfo()
const result = await doc.getLocaleInfo()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetLocaleInfo"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qDecimalSep": "value", "qThousandSep": "value", "qListSep": "value", "qMoneyDecimalSep": "value", "qMoneyThousandSep": "value", "qCurrentYear": 123, "qMoneyFmt": "value", "qTimeFmt": "value", "qDateFmt": "value", "qTimestampFmt": "value", "qCalendarStrings": { "qDayNames": [ "value" ], "qMonthNames": [ "value" ], "qLongDayNames": [ "value" ], "qLongMonthNames": [ "value" ] }, "qFirstWeekDay": 123, "qBrokenWeeks": true, "qReferenceDay": 123, "qFirstMonthOfYear": 123, "qCollation": "value", "qNumericalAbbreviation": "value" } }}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.
Response
- qv array of integers
Errors
arrayGetLooselyCoupledVector()
const result = await doc.getLooselyCoupledVector()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetLooselyCoupledVector"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qv": [ 123 ] }}Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.
Parameters
- qTags array of stringsRequired
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
Matching field mode. The default value is MATCHINGFIELDMODE_MATCH_ALL.
One of:
- MATCHINGFIELDMODE_MATCH_ALL
- MATCHINGFIELDMODE_MATCH_ONE
Response
- qFieldNames array of objects
qFieldNames properties
- qName string
Name of the field.
- qTags array of strings
List of tags.
-
Errors
arrayGetMatchingFields(qTags, qMatchingFieldMode?)
const result = await doc.getMatchingFields([ "value"], "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetMatchingFields", "params": { "qTags": [ "value" ], "qMatchingFieldMode": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qFieldNames": [ { "qName": "value", "qTags": [ "value" ] } ] }}Returns the handle of a measure.
Parameters
- qId stringRequired
Identifier of the measure.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetMeasure(qId)
const result = await doc.getMeasure("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetMeasure", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Returns the handle of a measure with a label. If multiple measures has the same label the first is returned.
Parameters
- qLabel stringRequired
is the label of the measure to be returned.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetMeasureWithLabel(qLabel)
const result = await doc.getMeasureWithLabel("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetMeasureWithLabel", "params": { "qLabel": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Lists the media files.
Response
- qList object
Lists the media files. Is the layout for MediaListDef.
This struct is deprecated.qList properties
- qItems array of objects
Information about the list of media files. In Qlik Sense Desktop, the media files are retrieved from: %userprofile%\Documents\Qlik\Sense\Content\Default In Qlik Sense Enterprise, the media files are retrieved from: <installation_directory>\Qlik\Sense\Repository\Content\Default The default installation directory is ProgramData .
qItems properties
- qUrlDef string
Relative path to the media file. The URL is static. Media files located:
- in the /content/default/ folder are outside the qvf file.
- in the /media/ folder are embedded in the qvf file.
- qUrl string
Relative path to the media file. Media files located:
- in the /content/default/ folder are outside the qvf file.
- in the /media/ folder are embedded in the qvf file.
-
-
- qReturn boolean
Errors
arrayGetMediaList()
const result = await doc.getMediaList()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetMediaList"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qList": { "qItems": [ { "qUrlDef": "value", "qUrl": "value" } ] }, "qReturn": true }}Returns the type of the app object and the corresponding handle.
Parameters
- qId stringRequired
Identifier of the object to retrieve.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetObject(qId)
const result = await doc.getObject("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetObject", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Returns all objects compatible with options.
Parameters
- qOptions objectRequired
Object type filter and requested properties.
qOptions properties
- qTypes array of strings
List of object types.
- qIncludeSessionObjects boolean
Set to true to include session objects. The default value is false.
- qData object
Contains dynamic JSON data specified by the client.
-
Response
- qList array of objects
qList properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qData object
Contains dynamic JSON data specified by the client.
-
Errors
arrayGetObjects(qOptions)
const result = await doc.getObjects({ "qTypes": [ "value" ], "qIncludeSessionObjects": false, "qData": {}})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetObjects", "params": { "qOptions": { "qTypes": [ "value" ], "qIncludeSessionObjects": false, "qData": {} } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qList": [ { "qInfo": { "qId": "value", "qType": "value" }, "qMeta": { "qName": "value" }, "qData": {} } ] }}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
- qProp objectRequired
GenericObjectProperties with at least Info : { "qId": "<identifier of the new generic object>", "qType": "<type of the new generic object>" }
qProp properties
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qExtendsId string
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDef object
Used to collect metadata.
Properties
Semantic type with an empty structure.
- qStateName string
Name of the alternate state. Default is current selections $ .
- qAppObjectListDef object
Defines the list of objects in an app.
An app object is a generic object created at app level.qAppObjectListDef properties
- qType string
Type of the app list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qBookmarkListDef object
Defines the list of bookmarks.
qBookmarkListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
- qIncludePatches boolean
Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
-
- qChildListDef object
Defines the list of children of a generic object. What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.
qChildListDef properties
- qData object
Contains dynamic JSON data specified by the client.
-
- qDimensionListDef object
Defines the lists of dimensions.
qDimensionListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qEmbeddedSnapshotDef object
Defines the embedded snapshot in a generic object.
Properties
"EmbeddedSnapshotDef": {}
- qExtensionListDef object
Obsolete, use qrs API's to fetch extensions.
- qFieldListDef object
Defines the fields to show.
qFieldListDef properties
- 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.
-
- qHyperCubeDef object
Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.
qHyperCubeDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qDimensions array of objects
Array of dimensions.
qDimensions properties
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qNullSuppression boolean
If set to true, no null values are returned.
- qIncludeElemValue boolean
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qShowTotal boolean
- qShowAll boolean
If set to true, all dimension values are shown.
- qOtherLabel object
qOtherLabel properties
- qv string
Expression evaluated to string.
-
- qTotalLabel object
qTotalLabel properties
- qv string
Expression evaluated to string.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
-
- qMeasures array of objects
Array of measures.
qMeasures properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qInterColumnSortOrder array of integers
Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure.
- qSuppressZero boolean
Removes zero values.
- qSuppressMissing boolean
Removes missing values.
- qInitialDataFetch array of objects
Initial data set.
qInitialDataFetch properties
- 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 ).
-
- qReductionMode string
Can be one of: "N""D1""S""C""ST"
- qMode string
Can be one of: "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 object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qSortbyYValue integer
To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.
- qTitle object
qTitle properties
- qv string
Expression evaluated to string.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qColumnOrder array of integers
The order of the columns.
- qExpansionState array of objectsExperimental
Expansion state per dimension for pivot mode ( qMode is P).
qExpansionState properties
- qExcludeList boolean
- qPos object
qPos properties
- qDimName string
- qElemNo array of integers
- qElemValues array of strings
-
-
- qDynamicScript array of stringsExperimental
Hypercube Modifier Dynamic script string
- qContextSetExpression string
Set expression valid for the whole cube, limiting computations to the specified set.
- qSuppressMeasureTotals boolean
When true, suppresses any grand totals for measures, regardless of the AggrFunc setting.
-
- qLayoutExclude object
Contains JSON to be excluded from validation.
- qListObjectDef object
Defines the properties of a list object. For more information about the definition of a list object, see Generic object.
qListObjectDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qAutoSortByState object
qAutoSortByState properties
- qDisplayNumberOfRows integer
This parameter applies to list objects. If the total number of values in the list object exceeds the value set in qDisplayNumberOfRows , the selected lines are promoted to the top of the list object. If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.
-
- qFrequencyMode string
Can be one of: "N""V""P""R"
- qShowAlternatives boolean
If set to true, alternative values are allowed in qData . If set to false, no alternative values are displayed in qData . Values are excluded instead. The default value is false. Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values. This parameter is optional.
- qInitialDataFetch array of objects
Fetches an initial data set.
qInitialDataFetch properties
- 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 ).
-
- qExpressions array of objects
Lists the expressions in the list object. This parameter is optional.
qExpressions properties
- qExpr string
Value of the expression.
- qLibraryId string
Refers to an expression stored in the library.
-
- qDirectQuerySimplifiedView booleanExperimental
If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false.
-
- qMeasureListDef object
Defines the list of measures.
qMeasureListDef properties
- qType string
Type of the list.
- qData object
Contains dynamic JSON data specified by the client.
-
- qMediaListDef object
Defines the list of media files.
This struct is deprecated.Properties
"qMediaListDef": {} qMediaListDef has an empty structure. No properties need to be set.
- qNxLibraryDimensionDef object
qNxLibraryDimensionDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of dimension names.
- qFieldLabels array of strings
Array of dimension labels.
- qLabelExpression string
- qAlias string
Alias of the dimension.
- qScriptGenerated boolean Deprecated
- qOrigin string
Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"
-
- qNxLibraryMeasureDef object
qNxLibraryMeasureDef properties
- qLabel string
Label of the measure.
- qDef string
Definition of the measure.
- qGrouping string
Can be one of: "N""H""C"
- qExpressions array of strings
Array of expressions.
- qActiveExpression integer
Index to the active expression in a measure.
- qLabelExpression string
Optional expression used for dynamic label.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qScriptGenerated boolean Deprecated
- qOrigin string
Can be one of: "PROGRAM""SCRIPT""DATA_PRODUCT"
-
- qSelectionObjectDef object
To display the current selections. Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.
Properties
"qSelectionObjectDef": {}
qSelectionObjectDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
-
- qStaticContentUrlDef objectIn addition, this structure can contain dynamic properties.
qStaticContentUrlDef properties
- qUrl string
Relative path of the thumbnail.
-
- qStringExpression object
Properties
Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where:
- < expression > is a string
The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.A string expression is not evaluated, if the expression is surrounded by simple quotes.The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.qStringExpression properties
- qExpr string
- qTreeDataDef object
Defines the properties of a TreeData object. For more information about the definition of a TreeData object, see Generic object.
qTreeDataDef properties
- qStateName string
Name of the alternate state. Default is current selections $ .
- qDimensions array of objects
Array of dimensions.
qDimensions properties
- qLibraryId string
Refers to a dimension stored in the library.
- qDef object
qDef properties
- qGrouping string
Can be one of: "N""H""C"
- qFieldDefs array of strings
Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
- qFieldLabels array of strings
Array of field labels. This parameter is optional.
- qSortCriterias array of objects
Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
qSortCriterias properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qNumberPresentations array of objects
Defines the format of the value. This parameter is optional.
qNumberPresentations properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
-
- 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.
-
- qValueExprs array of objects
List of measures.
qValueExprs properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qNullSuppression boolean
If set to true, no null values are returned.
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qShowAll boolean
If set to true, all dimension values are shown.
- qOtherLabel object
qOtherLabel properties
- qv string
Expression evaluated to string.
-
- qTotalLabel object
qTotalLabel properties
- qv string
Expression evaluated to string.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
-
- qInterColumnSortOrder array of integers
Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.
- qSuppressZero boolean
Removes zero values.
- 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 object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTitle object
qTitle properties
- qv string
Expression evaluated to string.
-
- qInitialDataFetch array of objects
Initial data set. This property is optional.
qInitialDataFetch properties
- 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 objects
Defines areas of the tree to be fetched. Areas must be defined left to right.
qTreeNodes properties
- qArea object
qArea properties
- 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 ).
-
- qAllValues boolean
When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
-
- qTreeLevels object
qTreeLevels properties
- qLeft integer
The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.
- qDepth integer
Number of dimensions to include in the tree.
-
-
- qExpansionState array of objectsExperimental
Expansion state per dimension.
qExpansionState properties
- qExcludeList boolean
- qPos object
qPos properties
- qDimName string
- qElemNo array of integers
- qElemValues array of strings
-
-
- qValueExprs array of objects
List of measures to calculate on the whole tree.
qValueExprs properties
- qLibraryId string
Refers to a measure stored in the library.
- qDef object
qDef properties
- qLabel string
Name of the measure. An empty string is returned as a default value. This parameter is optional.
- qDescription string
Description of the measure. An empty string is returned as a default value. This parameter is optional.
- qTags array of strings
Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
- qGrouping string
Can be one of: "N""H""C"
- qDef string
Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qRelative boolean
If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
- qBrutalSum boolean
If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
- qAggrFunc string
Indicates how to aggregate the measure to create a grand total. "None" - No total calculation is performed. "Expr" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as "Expr". This parameter is optional.
- qAccumulate integer
- 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the qAccumulate value Default value is 0. This parameter is optional.
- 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 strings
Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
- qLabelExpression string
Label expression. This parameter is optional.
-
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qAttributeDimensions array of objects
List of attribute dimensions.
qAttributeDimensions properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qAttribute boolean
If set to true, this attribute will not affect the number of rows in the cube.
-
- qCalcCond object
qCalcCond properties
- qv string
Expression evaluated to dual.
-
- qCalcCondition object
qCalcCondition properties
- qCond object
qCond properties
- qv string
Expression evaluated to dual.
-
- qMsg object
qMsg properties
- qv string
Expression evaluated to string.
-
-
- qTrendLines array of objectsExperimental
Specifies trendlines for this measure.
qTrendLines properties
- qType string
Can be one of: "AVERAGE""LINEAR""POLYNOMIAL2""POLYNOMIAL3""POLYNOMIAL4""EXPONENTIAL""POWER""LOG"
- qXColIx integer
The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
- qCalcR2 boolean
Set to true to calulatate the R2 score
- qContinuousXAxis string
Can be one of: "Never""Possible""Time"
- qMultiDimMode string
Can be one of: "Multi""Sum"
-
- qMiniChartDef object
qMiniChartDef properties
- qDef string
Expression or field name.
- qLibraryId string
LibraryId for dimension.
- qSortBy object
qSortBy properties
- 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 object
qExpression properties
- qv string
Expression evaluated to dual.
-
- qSortByGreyness integer
-
- qOtherTotalSpec object
qOtherTotalSpec properties
- qOtherMode string
Can be one of: "OTHER_OFF""OTHER_COUNTED""OTHER_ABS_LIMITED""OTHER_ABS_ACC_TARGET""OTHER_REL_LIMITED""OTHER_REL_ACC_TARGET"
- qOtherCounted object
qOtherCounted properties
- qv string
Expression evaluated to dual.
-
- qOtherLimit object
qOtherLimit properties
- qv string
Expression evaluated to dual.
-
- qOtherLimitMode string
Can be one of: "OTHER_GE_LIMIT""OTHER_LE_LIMIT""OTHER_GT_LIMIT""OTHER_LT_LIMIT"
- qSuppressOther boolean
If set to true, the group Others is not displayed as a dimension value. The default value is false.
- 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 string
Can be one of: "OTHER_SORT_DEFAULT""OTHER_SORT_DESCENDING""OTHER_SORT_ASCENDING"
- qTotalMode string
Can be one of: "TOTAL_OFF""TOTAL_EXPR"
- qReferencedExpression object
qReferencedExpression properties
- qv string
Expression evaluated to string.
-
-
- qMaxNumberPoints integer
- qAttributeExpressions array of objects
List of attribute expressions.
qAttributeExpressions properties
- qExpression string
Definition of the attribute expression. Example: "Max(OrderID)"
- qLibraryId string
Definition of the attribute expression stored in the library. Example: "MyGenericMeasure"
- qAttribute boolean
If set to true, this measure will not affect the number of rows in the cube.
- qNumFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- qLabel string
Label of the attribute expression.
- qLabelExpression string
Optional expression used for dynamic label.
-
- qNullSuppression boolean
If set to true, no null values are returned.
-
-
- qContextSetExpression string
Set expression valid for the whole cube, limiting computations to the specified set.
-
- qUndoInfoDef object
Defines if an object should contain information on the number of possible undo and redo.
Properties
"qUndoInfoDef": {} The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.
- qValueExpression object
Properties
Abbreviated syntax: "qValueExpression":"=<expression>" Extended object syntax: "qValueExpression":{"qExpr":"=<expression>"} Where:
- < expression > is a string.
The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.The expression is evaluated as a numeric.qValueExpression properties
- qExpr string
- qVariableListDef object
Defines the list of variables in an app.
qVariableListDef properties
- qType string
Type of variables to include in the list.
- qShowReserved boolean
Shows the reserved variables if set to true.
- qShowConfig boolean
Shows the system variables if set to true.
- qData object
Contains dynamic JSON data specified by the client.
- qShowSession boolean
Shows the session variables if set to true.
-
additional optional properties
- object objectPrivateAny of:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
-
-
Response
- qNewObject boolean
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetOrCreateObject(qProp)
const result = await doc.getOrCreateObject({ "qInfo": { "qId": "value", "qType": "value" }, "qExtendsId": "value", "qMetaDef": {}, "qStateName": "value", "qAppObjectListDef": { "qType": "value", "qData": {} }, "qBookmarkListDef": { "qType": "value", "qData": {}, "qIncludePatches": true }, "qChildListDef": { "qData": {} }, "qDimensionListDef": { "qType": "value", "qData": {} }, "qEmbeddedSnapshotDef": {}, "qExtensionListDef": {}, "qFieldListDef": { "qShowSystem": false, "qShowHidden": false, "qShowSemantic": false, "qShowSrcTables": false, "qShowDefinitionOnly": false, "qShowDerivedFields": false, "qShowImplicit": false }, "qHyperCubeDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qNullSuppression": true, "qIncludeElemValue": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowTotal": true, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCond": { "qv": "value" }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } } } ], "qMeasures": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qReductionMode": "N", "qMode": "S", "qPseudoDimPos": -1, "qNoOfLeftDims": -1, "qAlwaysFullyExpanded": false, "qMaxStackedCells": 5000, "qPopulateMissing": false, "qShowTotalsAbove": false, "qIndentMode": false, "qCalcCond": { "qv": "value" }, "qSortbyYValue": 0, "qTitle": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qColumnOrder": [ 123 ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qDynamicScript": [ "value" ], "qContextSetExpression": "value", "qSuppressMeasureTotals": true }, "qLayoutExclude": {}, "qListObjectDef": { "qStateName": "value", "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qAutoSortByState": { "qDisplayNumberOfRows": 123 }, "qFrequencyMode": "N", "qShowAlternatives": true, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qExpressions": [ { "qExpr": "value", "qLibraryId": "value" } ], "qDirectQuerySimplifiedView": true }, "qMeasureListDef": { "qType": "value", "qData": {} }, "qMediaListDef": {}, "qNxLibraryDimensionDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qLabelExpression": "value", "qAlias": "value", "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qNxLibraryMeasureDef": { "qLabel": "value", "qDef": "value", "qGrouping": "N", "qExpressions": [ "value" ], "qActiveExpression": 123, "qLabelExpression": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qSelectionObjectDef": { "qStateName": "value" }, "qStaticContentUrlDef": { "qUrl": "value" }, "qStringExpression": { "qExpr": "value" }, "qTreeDataDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qNullSuppression": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ] } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qOpenFullyExpanded": false, "qPopulateMissing": false, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTitle": { "qv": "value" }, "qInitialDataFetch": [ { "qMaxNbrOfNodes": 123, "qTreeNodes": [ { "qArea": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qAllValues": true } ], "qTreeLevels": { "qLeft": 123, "qDepth": -1 } } ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qContextSetExpression": "value" }, "qUndoInfoDef": {}, "qValueExpression": { "qExpr": "value" }, "qVariableListDef": { "qType": "value", "qShowReserved": true, "qShowConfig": true, "qData": {}, "qShowSession": true }})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetOrCreateObject", "params": { "qProp": { "qInfo": { "qId": "value", "qType": "value" }, "qExtendsId": "value", "qMetaDef": {}, "qStateName": "value", "qAppObjectListDef": { "qType": "value", "qData": {} }, "qBookmarkListDef": { "qType": "value", "qData": {}, "qIncludePatches": true }, "qChildListDef": { "qData": {} }, "qDimensionListDef": { "qType": "value", "qData": {} }, "qEmbeddedSnapshotDef": {}, "qExtensionListDef": {}, "qFieldListDef": { "qShowSystem": false, "qShowHidden": false, "qShowSemantic": false, "qShowSrcTables": false, "qShowDefinitionOnly": false, "qShowDerivedFields": false, "qShowImplicit": false }, "qHyperCubeDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qNullSuppression": true, "qIncludeElemValue": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowTotal": true, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCond": { "qv": "value" }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } } } ], "qMeasures": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qReductionMode": "N", "qMode": "S", "qPseudoDimPos": -1, "qNoOfLeftDims": -1, "qAlwaysFullyExpanded": false, "qMaxStackedCells": 5000, "qPopulateMissing": false, "qShowTotalsAbove": false, "qIndentMode": false, "qCalcCond": { "qv": "value" }, "qSortbyYValue": 0, "qTitle": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qColumnOrder": [ 123 ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qDynamicScript": [ "value" ], "qContextSetExpression": "value", "qSuppressMeasureTotals": true }, "qLayoutExclude": {}, "qListObjectDef": { "qStateName": "value", "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qAutoSortByState": { "qDisplayNumberOfRows": 123 }, "qFrequencyMode": "N", "qShowAlternatives": true, "qInitialDataFetch": [ { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 } ], "qExpressions": [ { "qExpr": "value", "qLibraryId": "value" } ], "qDirectQuerySimplifiedView": true }, "qMeasureListDef": { "qType": "value", "qData": {} }, "qMediaListDef": {}, "qNxLibraryDimensionDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qLabelExpression": "value", "qAlias": "value", "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qNxLibraryMeasureDef": { "qLabel": "value", "qDef": "value", "qGrouping": "N", "qExpressions": [ "value" ], "qActiveExpression": 123, "qLabelExpression": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qScriptGenerated": false, "qOrigin": "PROGRAM" }, "qSelectionObjectDef": { "qStateName": "value" }, "qStaticContentUrlDef": { "qUrl": "value" }, "qStringExpression": { "qExpr": "value" }, "qTreeDataDef": { "qStateName": "value", "qDimensions": [ { "qLibraryId": "value", "qDef": { "qGrouping": "N", "qFieldDefs": [ "value" ], "qFieldLabels": [ "value" ], "qSortCriterias": [ { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 } ], "qNumberPresentations": [ { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" } ], "qReverseSort": true, "qActiveField": 123, "qLabelExpression": "value", "qAlias": "value" }, "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qNullSuppression": true, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qShowAll": true, "qOtherLabel": { "qv": "value" }, "qTotalLabel": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ] } ], "qInterColumnSortOrder": [ 123 ], "qSuppressZero": false, "qSuppressMissing": false, "qOpenFullyExpanded": false, "qPopulateMissing": false, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTitle": { "qv": "value" }, "qInitialDataFetch": [ { "qMaxNbrOfNodes": 123, "qTreeNodes": [ { "qArea": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qAllValues": true } ], "qTreeLevels": { "qLeft": 123, "qDepth": -1 } } ], "qExpansionState": [ { "qExcludeList": true, "qPos": { "qDimName": "value", "qElemNo": [ 123 ], "qElemValues": [ "value" ] } } ], "qValueExprs": [ { "qLibraryId": "value", "qDef": { "qLabel": "value", "qDescription": "value", "qTags": [ "value" ], "qGrouping": "N", "qDef": "value", "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qRelative": true, "qBrutalSum": true, "qAggrFunc": "value", "qAccumulate": 123, "qReverseSort": true, "qActiveExpression": 123, "qExpressions": [ "value" ], "qLabelExpression": "value" }, "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qAttributeDimensions": [ { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qAttribute": true } ], "qCalcCond": { "qv": "value" }, "qCalcCondition": { "qCond": { "qv": "value" }, "qMsg": { "qv": "value" } }, "qTrendLines": [ { "qType": "AVERAGE", "qXColIx": -1, "qCalcR2": false, "qContinuousXAxis": "Never", "qMultiDimMode": "Multi" } ], "qMiniChartDef": { "qDef": "value", "qLibraryId": "value", "qSortBy": { "qSortByState": 123, "qSortByFrequency": 123, "qSortByNumeric": 123, "qSortByAscii": 123, "qSortByLoadOrder": 123, "qSortByExpression": 123, "qExpression": { "qv": "value" }, "qSortByGreyness": 123 }, "qOtherTotalSpec": { "qOtherMode": "OTHER_OFF", "qOtherCounted": { "qv": "value" }, "qOtherLimit": { "qv": "value" }, "qOtherLimitMode": "OTHER_GE_LIMIT", "qSuppressOther": false, "qForceBadValueKeeping": true, "qApplyEvenWhenPossiblyWrongResult": true, "qGlobalOtherGrouping": false, "qOtherCollapseInnerDimensions": false, "qOtherSortMode": "OTHER_SORT_DEFAULT", "qTotalMode": "TOTAL_OFF", "qReferencedExpression": { "qv": "value" } }, "qMaxNumberPoints": -1, "qAttributeExpressions": [ { "qExpression": "value", "qLibraryId": "value", "qAttribute": true, "qNumFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qLabel": "value", "qLabelExpression": "value" } ], "qNullSuppression": true } } ], "qContextSetExpression": "value" }, "qUndoInfoDef": {}, "qValueExpression": { "qExpr": "value" }, "qVariableListDef": { "qType": "value", "qShowReserved": true, "qShowConfig": true, "qData": {}, "qShowSession": true } } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qNewObject": true, "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}GetScript()
const result = await doc.getScript()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetScript"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qScript": "value" }}Lists the breakpoints in the script of an app.
Response
- qBreakpoints array of objects
qBreakpoints properties
- 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).
-
Errors
arrayGetScriptBreakpoints()
const result = await doc.getScriptBreakpoints()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetScriptBreakpoints"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qBreakpoints": [ { "qbufferName": "value", "qlineIx": 123, "qEnabled": true } ] }}Gets script and script metadata.
Response
- qScript object
qScript properties
- qScript string
Script text.
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qIsLocked boolean
When true, the user is temporarily locked from modifying the script. The Meta information contains the ID of the last modifier. Only applicable to Qlik Cloud.
-
Errors
arrayGetScriptEx()
const result = await doc.getScriptEx()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetScriptEx"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qScript": { "qScript": "value", "qMeta": { "qName": "value" }, "qIsLocked": true } }}Gets script metadata.
Response
- qMeta objectExperimental
qMeta properties
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qIsLocked boolean
When true, the user is temporarily locked from modifying the script. The Meta information contains the ID of the last modifier. Only applicable to Qlik Cloud.
-
Errors
arrayGetScriptMeta()
const result = await doc.getScriptMeta()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetScriptMeta"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qMeta": { "qMeta": { "qName": "value" }, "qIsLocked": true } }}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
- qStateName string
Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved.
- qBookmarkId string
Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved.
Response
- qSetExpression string
Errors
arrayGetSetAnalysis(qStateName?, qBookmarkId?)
const result = await doc.getSetAnalysis("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetSetAnalysis", "params": { "qStateName": "value", "qBookmarkId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSetExpression": "value" }}Retrieves the data of a specific table.
Parameters
- qOffset integerRequired
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 integerRequired
Number of rows to show.
- qSyntheticMode booleanRequired
If this parameter is set to true, the internal data/table representation is shown. Synthetic fields are present (if any).
- qTableName stringRequired
Name of the table.
Response
- qData array of objects
qData properties
- qValue array of objects
Array of field values.
qValue properties
- qText string
Text related to the field value. This parameter is optional.
- qIsNumeric boolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumber number
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
-
Errors
arrayGetTableData(qOffset, qRows, qSyntheticMode, qTableName)
const result = await doc.getTableData(123, 123, true, "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetTableData", "params": { "qOffset": 123, "qRows": 123, "qSyntheticMode": true, "qTableName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qData": [ { "qValue": [ { "qText": "value", "qIsNumeric": true, "qNumber": 123 } ] } ] }}Returns profile data for a given table.
Parameters
- qTableName stringRequired
Name of the table
Response
- qProfiling object
qProfiling properties
- qNoOfRows integer
Number of rows in the table.
- qFieldProfiling array of objects
Field values profiling info
qFieldProfiling properties
- qName string
Name of the field.
- qFieldTags array of strings
List of tags related to the field.
- qNumberFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- 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 numbers
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 objects
Three most frequent values and their frequencies
qMostFrequent properties
- qSymbol object
qSymbol properties
- qText string
String value of the symbol. This parameter is optional and present only if Symbol is a string.
- qNumber number
Numeric value of the symbol. NaN otherwise.
-
- qFrequency integer
Frequency of the above symbol in the field
-
- qFrequencyDistribution object
qFrequencyDistribution properties
- qNumberOfBins integer
Number of bins.
- qBinsEdges array of numbers
Bins edges.
- qFrequencies array of integers
Bins frequencies.
-
- qDataEvenness number
Data evenness aka Shannon's entropy normalized to [0,1]
-
-
Errors
arrayGetTableProfileData(qTableName)
const result = await doc.getTableProfileData("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetTableProfileData", "params": { "qTableName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qProfiling": { "qNoOfRows": 123, "qFieldProfiling": [ { "qName": "value", "qFieldTags": [ "value" ], "qNumberFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qDistinctValues": 123, "qDistinctNumericValues": 123, "qDistinctTextValues": 123, "qNumericValues": 123, "qNullValues": 123, "qTextValues": 123, "qNegValues": 123, "qPosValues": 123, "qZeroValues": 123, "qSum": 123, "qSum2": 123, "qAverage": 123, "qMedian": 123, "qStd": 123, "qMin": 123, "qMax": 123, "qSkewness": 123, "qKurtosis": 123, "qFractiles": [ 123 ], "qEmptyStrings": 123, "qMaxStringLen": 123, "qMinStringLen": 123, "qSumStringLen": 123, "qAvgStringLen": 123, "qFirstSorted": "value", "qLastSorted": "value", "qMostFrequent": [ { "qSymbol": { "qText": "value", "qNumber": 123 }, "qFrequency": 123 } ], "qFrequencyDistribution": { "qNumberOfBins": 123, "qBinsEdges": [ 123 ], "qFrequencies": [ 123 ] }, "qDataEvenness": 123 } ] } }}Doc GetTablesAndKeys
(qWindowSize, qNullSize, qCellHeight, qSyntheticMode, qIncludeSysVars, qIncludeProfiling?)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
- qWindowSize objectRequired
Size of the window that is used to display the results.
qWindowSize properties
- qcx integer
Number of pixels on the x axis.
- qcy integer
Number of pixels on the y axis.
-
- qNullSize objectRequired
qNullSize properties
- qcx integer
Number of pixels on the x axis.
- qcy integer
Number of pixels on the y axis.
-
- qCellHeight integerRequired
Height of a cell in a table in pixels.
- qSyntheticMode booleanRequired
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 booleanRequired
If set to true, the system variables are included.
- qIncludeProfiling boolean
If set to true, profiling information is included.
Response
- qtr array of objects
qtr properties
- qName string
Name of the table.
- qLoose boolean
This property is set to true if the table is loose.
- qNoOfRows integer
Number of rows in the table.
- qFields array of objects
Information about the fields in the table.
qFields properties
- qName string
Name of the field.
- qOriginalFields array of strings
Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file.
- qPresent boolean
- qHasNull boolean
This property is set to true if the field contains some Null values.
- qHasWild boolean
- qHasDuplicates boolean
This property is set to true if the field contains some duplicate values.
- qIsSynthetic boolean
This property is set to true if the field contains a synthetic key.
- qInformationDensity number
Number of records that have values (for example, not NULL) in the field as compared to the total number of records in the table.
- 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 string
Can be one of: "NOT_KEY""ANY_KEY""PRIMARY_KEY""PERFECT_KEY"
- qComment string
Comment related to the field.
- qTags array of strings
List of tags related to the field.
- qDerivedFields array of objects
List of the derived fields.
qDerivedFields properties
- qDefinitionName string
Name of the derived definition.
- qTags array of strings
List of tags.
- qActive boolean
Is set to true is the derived field is in use.
-
- qIsFieldOnTheFly boolean
- qReadableName string
-
- qPos object
qPos properties
- 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.
-
- qComment string
Comment related to the table.
- qIsDirectDiscovery boolean
If set to true, Direct Discovery is used. Direct Discovery fields are not loaded into memory and remain in the external database.
- qIsSynthetic boolean
This property is set to true if the table contains a synthetic key.
- qTableTags array of strings
List of tags related to the table.
- qProfilingData object
qProfilingData properties
- qNoOfRows integer
Number of rows in the table.
- qFieldProfiling array of objects
Field values profiling info
qFieldProfiling properties
- qName string
Name of the field.
- qFieldTags array of strings
List of tags related to the field.
- qNumberFormat object
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberFormat properties
- qType string
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDec integer
Number of decimals. Default is 10.
- 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: ,
- 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 numbers
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 objects
Three most frequent values and their frequencies
qMostFrequent properties
- qSymbol object
qSymbol properties
- qText string
String value of the symbol. This parameter is optional and present only if Symbol is a string.
- qNumber number
Numeric value of the symbol. NaN otherwise.
-
- qFrequency integer
Frequency of the above symbol in the field
-
- qFrequencyDistribution object
qFrequencyDistribution properties
- qNumberOfBins integer
Number of bins.
- qBinsEdges array of numbers
Bins edges.
- qFrequencies array of integers
Bins frequencies.
-
- qDataEvenness number
Data evenness aka Shannon's entropy normalized to [0,1]
-
-
-
- qk array of objects
qk properties
- qKeyFields array of strings
Name of the key field.
- qTables array of strings
Table the key belongs to.
-
Errors
arrayGetTablesAndKeys(qWindowSize, qNullSize, qCellHeight, qSyntheticMode, qIncludeSysVars, qIncludeProfiling?)
const result = await doc.getTablesAndKeys({ "qcx": 123, "qcy": 123}, { "qcx": 123, "qcy": 123}, 123, true, true, true)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetTablesAndKeys", "params": { "qWindowSize": { "qcx": 123, "qcy": 123 }, "qNullSize": { "qcx": 123, "qcy": 123 }, "qCellHeight": 123, "qSyntheticMode": true, "qIncludeSysVars": true, "qIncludeProfiling": true }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qtr": [ { "qName": "value", "qLoose": true, "qNoOfRows": 123, "qFields": [ { "qName": "value", "qOriginalFields": [ "value" ], "qPresent": true, "qHasNull": true, "qHasWild": true, "qHasDuplicates": true, "qIsSynthetic": true, "qInformationDensity": 123, "qnNonNulls": 123, "qnRows": 123, "qSubsetRatio": 123, "qnTotalDistinctValues": 123, "qnPresentDistinctValues": 123, "qKeyType": "NOT_KEY", "qComment": "value", "qTags": [ "value" ], "qDerivedFields": [ { "qDefinitionName": "value", "qTags": [ "value" ], "qActive": true } ], "qIsFieldOnTheFly": false, "qReadableName": "value" } ], "qPos": { "qx": 123, "qy": 123 }, "qComment": "value", "qIsDirectDiscovery": true, "qIsSynthetic": true, "qTableTags": [ "value" ], "qProfilingData": { "qNoOfRows": 123, "qFieldProfiling": [ { "qName": "value", "qFieldTags": [ "value" ], "qNumberFormat": { "qType": "U", "qnDec": 10, "qUseThou": 0, "qFmt": "value", "qDec": "value", "qThou": "value" }, "qDistinctValues": 123, "qDistinctNumericValues": 123, "qDistinctTextValues": 123, "qNumericValues": 123, "qNullValues": 123, "qTextValues": 123, "qNegValues": 123, "qPosValues": 123, "qZeroValues": 123, "qSum": 123, "qSum2": 123, "qAverage": 123, "qMedian": 123, "qStd": 123, "qMin": 123, "qMax": 123, "qSkewness": 123, "qKurtosis": 123, "qFractiles": [ 123 ], "qEmptyStrings": 123, "qMaxStringLen": 123, "qMinStringLen": 123, "qSumStringLen": 123, "qAvgStringLen": 123, "qFirstSorted": "value", "qLastSorted": "value", "qMostFrequent": [ { "qSymbol": { "qText": "value", "qNumber": 123 }, "qFrequency": 123 } ], "qFrequencyDistribution": { "qNumberOfBins": 123, "qBinsEdges": [ 123 ], "qFrequencies": [ 123 ] }, "qDataEvenness": 123 } ] } } ], "qk": [ { "qKeyFields": [ "value" ], "qTables": [ "value" ] } ] }}Fetches updated variables after a statement execution.
Response
- qMacros array of objects
qMacros properties
- qTag string
Name of the variable.
- qRefSeqNo integer
Order in which the variable was referenced during the script execution. The same number sequence is used for both qRefSeqNo and qSetSeqNo .
- 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.
-
Errors
arrayGetTextMacros()
const result = await doc.getTextMacros()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetTextMacros"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qMacros": [ { "qTag": "value", "qRefSeqNo": 123, "qSetSeqNo": 123, "qDisplayString": "value", "qIsSystem": false, "qIsReserved": false } ] }}Returns a handle to a variable.
Parameters
- qName stringRequired
Name of the variable.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetVariable(qName)
const result = await doc.getVariable("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetVariable", "params": { "qName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Gets the handle of a variable.
Parameters
- qId stringRequired
Identifier of the variable.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetVariableById(qId)
const result = await doc.getVariableById("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetVariableById", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Gets the handle of a variable.
Parameters
- qName stringRequired
Name of the variable.
Response
- qReturn object
qReturn properties
- 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.
-
Errors
arrayGetVariableByName(qName)
const result = await doc.getVariableByName("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetVariableByName", "params": { "qName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Parameters
- qListDef objectRequired
qListDef properties
- qType string
Type of variables to include in the list.
- qShowReserved boolean
Shows the reserved variables if set to true.
- qShowConfig boolean
Shows the system variables if set to true.
- qData object
Contains dynamic JSON data specified by the client.
- qShowSession boolean
Shows the session variables if set to true.
-
Response
- qList array of objects
qList properties
- qName string
Name of the variable.
- qDescription string
Description of the variable.
- qDefinition string
Definition of the variable. It can be a value or an expression.
- qIsConfig boolean
If set to true, it means that the variable is a system variable. A system variable provides information about the system and is set by the engine. The content cannot be changed by the user. This parameter is optional. The default value is false.
- 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 object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qData object
Contains dynamic JSON data specified by the client.
- qIsScriptCreated boolean
If set to true, it means that the variable was defined via script.
-
Errors
arrayGetVariables(qListDef)
const result = await doc.getVariables({ "qType": "value", "qShowReserved": true, "qShowConfig": true, "qData": {}, "qShowSession": true})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetVariables", "params": { "qListDef": { "qType": "value", "qShowReserved": true, "qShowConfig": true, "qData": {}, "qShowSession": true } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qList": [ { "qName": "value", "qDescription": "value", "qDefinition": "value", "qIsConfig": false, "qIsReserved": false, "qMeta": { "qName": "value" }, "qInfo": { "qId": "value", "qType": "value" }, "qData": {}, "qIsScriptCreated": true } ] }}Returns information about the position of the tables in the data model viewer.
Response
- qReturn object
qReturn properties
- qPos object
qPos properties
- 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 ).
-
- qCtlInfo object
qCtlInfo properties
- qInternalView object
qInternalView properties
- qTables array of objects
List of the tables in the database model viewer.
qTables properties
- qPos object
qPos properties
- 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 ).
-
- qCaption string
Table name.
-
- qBroomPoints array of objects
List of the broom points in the database model viewer. Not used in Qlik Sense.
qBroomPoints properties
- qPos object
qPos properties
- 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.
-
- qTable string
Name of the table.
- qFields array of strings
List of fields in the table.
-
- qConnectionPoints array of objects
List of connection points in the database model viewer. Not used in Qlik Sense.
qConnectionPoints properties
- qPos object
qPos properties
- 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.
-
- qFields array of strings
List of the fields in the table.
-
- qZoomFactor number
Zoom factor in the database model viewer. The default value is 1.0.
-
- qSourceView object
qSourceView properties
- qTables array of objects
List of the tables in the database model viewer.
qTables properties
- qPos object
qPos properties
- 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 ).
-
- qCaption string
Table name.
-
- qBroomPoints array of objects
List of the broom points in the database model viewer. Not used in Qlik Sense.
qBroomPoints properties
- qPos object
qPos properties
- 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.
-
- qTable string
Name of the table.
- qFields array of strings
List of fields in the table.
-
- qConnectionPoints array of objects
List of connection points in the database model viewer. Not used in Qlik Sense.
qConnectionPoints properties
- qPos object
qPos properties
- 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.
-
- qFields array of strings
List of the fields in the table.
-
- qZoomFactor number
Zoom factor in the database model viewer. The default value is 1.0.
-
-
- 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.
-
Errors
arrayGetViewDlgSaveInfo()
const result = await doc.getViewDlgSaveInfo()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetViewDlgSaveInfo"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": { "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCtlInfo": { "qInternalView": { "qTables": [ { "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCaption": "value" } ], "qBroomPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qTable": "value", "qFields": [ "value" ] } ], "qConnectionPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qFields": [ "value" ] } ], "qZoomFactor": 1 }, "qSourceView": { "qTables": [ { "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCaption": "value" } ], "qBroomPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qTable": "value", "qFields": [ "value" ] } ], "qConnectionPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qFields": [ "value" ] } ], "qZoomFactor": 1 } }, "qMode": 123 } }}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
- GOOGLE_SHEET for Google Sheet 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
- GOOGLE_SHEET for Google Sheet file
Parameters
- qConnectionId stringRequired
Identifier of the connection file.
- qRelativePath string
Path of the connection file.
Response
- qDataFormat object
FileType
Recognized file formats are:
- CSV for Delimited
- FIX for Fixed Record
- DIF for Data Interchange Format
- EXCEL_BIFF for Microsoft Excel (XLS)
- EXCEL_OOXML for Microsoft Excel (XLSX)
- HTML for HTML
- QVD for QVD file
- XML for XML
- QVX for QVX file
- JSON for JSON format
- KML for KML file
- PARQUET for PARQUET file
- GOOGLE_SHEET for Google Sheet file
qDataFormat properties
- qType string
Can be one of: "CSV""FIX""DIF""EXCEL_BIFF""EXCEL_OOXML""HTML""QVD""XML""QVX""JSON""KML""PARQUET""GOOGLE_SHEET"
- qLabel string
One of:
- Embedded labels (field names are present in the file)
- No labels
- Explicit labels (for DIFfiles)
- qQuote string
One of:
- None (no quotes)
- MSQ (Modern Style Quoting)
- Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value)
This property is used for delimited files.
- qComment string
String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files.
- qDelimiter object
qDelimiter properties
- qName string
Name of the delimiter. Example: "Tab_DELIMITER"
- qScriptCode string
Representation of the delimiter value that is used in the script. Example: "'\t'"
- qNumber integer
Delimiter character number used by the engine to determine how to separate the values.
- qIsMultiple boolean
Is set to true if multiple spaces are used to separate the values.
-
- 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.
Errors
arrayGuessFileType(qConnectionId, qRelativePath?)
const result = await doc.guessFileType("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GuessFileType", "params": { "qConnectionId": "value", "qRelativePath": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qDataFormat": { "qType": "CSV", "qLabel": "value", "qQuote": "value", "qComment": "value", "qDelimiter": { "qName": "value", "qScriptCode": "value", "qNumber": 123, "qIsMultiple": true }, "qCodePage": 123, "qHeaderSize": 123, "qRecordSize": 123, "qTabSize": 123, "qIgnoreEOF": true, "qFixedWidthDelimiters": "value" } }}Locks all selections in fields for current state.
Parameters
- qStateName string
Alternate state name. When set, applies to alternate state instead of current.
Response
objectErrors
arrayLockAll(qStateName?)
const result = await doc.lockAll("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "LockAll", "params": { "qStateName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Updates a connection.
Parameters
- qConnectionId stringRequired
Identifier of the connection.
- qConnection objectRequired
Information about the connection. Properties that can be updated.
qConnection properties
- qId string
Identifier of the connection. Is generated by the engine and is unique.
- qName string
Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection.
- qConnectionString string
One of:
- ODBC CONNECT TO [<provider name>]
- OLEDB CONNECT TO [<provider name>]
- CUSTOM CONNECT TO [<provider name>]
- "<local absolute or relative path, UNC path>"
- "<URL>"
Connection string. This parameter is mandatory and must be set when creating or modifying a connection.
- qType string
One of:
- ODBC
- OLEDB
- <Name of the custom connection file>
- folder
- internet
Type of the connection. This parameter is mandatory and must be set when creating or modifying a connection. For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string. The type is not case sensitive.
- qUserName string
Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the user name.
- qPassword string
Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the password.
- qModifiedDate string
Is generated by the engine. Creation date of the connection or last modification date of the connection.
- qMeta object
Layout for NxMetaDef.
qMeta properties
- qName string
Name. This property is optional.
-
- qLogOn string
Can be one of: "LOG_ON_SERVICE_USER""LOG_ON_CURRENT_USER"
-
- qOverrideCredentials boolean
Set this parameter to true to override the user name and password.
Response
objectErrors
arrayModifyConnection(qConnectionId, qConnection, qOverrideCredentials?)
const result = await doc.modifyConnection("value", { "qId": "value", "qName": "value", "qConnectionString": "value", "qType": "value", "qUserName": "value", "qPassword": "value", "qModifiedDate": "value", "qMeta": { "qName": "value" }, "qLogOn": "LOG_ON_SERVICE_USER"}, true)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ModifyConnection", "params": { "qConnectionId": "value", "qConnection": { "qId": "value", "qName": "value", "qConnectionString": "value", "qType": "value", "qUserName": "value", "qPassword": "value", "qModifiedDate": "value", "qMeta": { "qName": "value" }, "qLogOn": "LOG_ON_SERVICE_USER" }, "qOverrideCredentials": true }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Publishes an app. All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.
Parameters
- qStreamId stringRequired
Identifier of the stream.
- qName string
Name of the published app. If this parameter is not set, the engine automatically gives a new name to the published app.
Response
objectErrors
arrayPublish(qStreamId, qName?)
const result = await doc.publish("value", "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Publish", "params": { "qStreamId": "value", "qName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Redoes the previous operation.
Response
- qSuccess boolean
Errors
arrayRedo()
const result = await doc.redo()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Redo"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes an alternate state in the app.
Parameters
- qStateName stringRequired
Name of the alternate state.
Response
objectErrors
arrayRemoveAlternateState(qStateName)
const result = await doc.removeAlternateState("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "RemoveAlternateState", "params": { "qStateName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Removes an session alternate state in the app.
Parameters
- qStateName stringRequired
Name of the alternate state.
Response
- qSuccess boolean
Errors
arrayRemoveSessionAlternateState(qStateName)
const result = await doc.removeSessionAlternateState("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "RemoveSessionAlternateState", "params": { "qStateName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Removes a variable.
Parameters
- qName stringRequired
Name of the variable. Variable names are case sensitive.
Response
- qReturn boolean
Errors
arrayRemoveVariable(qName)
const result = await doc.removeVariable("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "RemoveVariable", "params": { "qName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}Replaces a bookmark. Optional parameters to modify the original bookmark properties; if not specified, the original properties are retained.
Parameters
- qId stringRequired
Identifier of the bookmark.
- qIgnorePatches boolean
When true, excludes patches from the bookmark. The default value is false.
- qObjectIdsToPatch array of strings
Adds softpatches for these objects if available. If empty, all softpatches are added to the bookmark. Ignored if IgnorePatches is set to true.
Response
- qInfo object
qInfo properties
- qId string
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qType string
Type of the object. This parameter is mandatory.
-
- qReturn object
qReturn properties
- 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.
-
Errors
arrayReplaceBookmark(qId, qIgnorePatches?, qObjectIdsToPatch?)
const result = await doc.replaceBookmark("value", true, [ "value"])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ReplaceBookmark", "params": { "qId": "value", "qIgnorePatches": true, "qObjectIdsToPatch": [ "value" ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qInfo": { "qId": "value", "qType": "value" }, "qReturn": { "qType": "value", "qHandle": 123, "qGenericType": "value", "qGenericId": "value" } }}Restore a temporary selection state identified by Id.
Parameters
- qId stringRequired
Identifier of the temporary selection state
Response
- qReturn boolean
Errors
arrayRestoreTempSelectionState(qId)
const result = await doc.restoreTempSelectionState("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "RestoreTempSelectionState", "params": { "qId": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}Resume()
const result = await doc.resume()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Resume"}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Save a copy of an app with a different name. Can be used to save a session app as an ordinary app.
Parameters
- qNewAppName stringRequired
<Name of the saved app>
Response
- qNewAppId string
Errors
arraySaveAs(qNewAppName)
const result = await doc.saveAs("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SaveAs", "params": { "qNewAppName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qNewAppId": "value" }}Saves all objects that were modified in the app.
Response
objectErrors
arraySaveObjects()
const result = await doc.saveObjects()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SaveObjects"}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}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.
Parameters
- qFieldName stringRequired
Name of the field to scramble.
Response
objectErrors
arrayScramble(qFieldName)
const result = await doc.scramble("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Scramble", "params": { "qFieldName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}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
- qOptions objectRequired
Information about the search fields and the search context.
qOptions properties
- qSearchFields array of strings
List of the search fields. If empty, the search is performed in all fields of the app.
- qContext string
Can be one of: "Cleared""LockedFieldsOnly""CurrentSelections"
- qCharEncoding string
Can be one of: "Utf8""Utf16"
- qAttributes array of strings
Optional.
- For SearchSuggest method, this array is empty.
- For SearchObjects method, this array is empty or contain qProperty .
- For SearchResults method, this array is empty, or contains qNum and/or qElemNum . It allows the user to request details in the outputted SearchGroupItemMatch . For more information, see SearchGroupItemMatch.
-
- qTerms array of stringsRequired
List of terms to search for.
- qPage objectRequired
Array of pages to retrieve.
qPage properties
- qOffset integer
Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0.
- 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 objects
Options of the search groups. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method.
qGroupOptions properties
- qGroupType string
Can be one of: "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.
-
- qGroupItemOptions array of objects
Options of the search group items. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method.
qGroupItemOptions properties
- qGroupItemType string
Can be one of: "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.
-
-
Response
- qResults object Deprecated
qResults properties
- qFieldNames array of strings
List of the fields that contains search associations.
- qSearchTerms array of strings
List of the search terms.
- qFieldDictionaries array of objects Deprecated
Information about the fields containing search hits.
qFieldDictionaries properties
- qField integer
Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.
- qResult array of objects Deprecated
List of the matching values. The maximum number of values in this list is set by qMaxNbrFieldMatches .
qResult properties
- qText string
Text of the associated value.
- qElemNumber integer
Element number of the associated value.
- qRanges array of objects
List of ranges. For example, if the user searches the term read and the associative value is Reading , then the corresponding range would be Read in Reading .
qRanges properties
- 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.
-
-
-
- qSearchTermsMatched array of arrays Deprecated
List of search results. The maximum number of search results in this list is set by qPage/qCount .
qSearchTermsMatched properties
- qId integer
Index of the search result, starting from 0.
- qFieldMatches array of objects Deprecated
Information about the search matches.
qFieldMatches properties
- qField integer
Position of the field in the list of fields, starting from 0. The list of fields is defined in qResults/qFieldNames and contains the search associations.
- qValues array of integers
Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .
- qTerms array of integers
Positions of the search terms, starting from 0.
- qNoOfMatches integer
Number of search hits in the field. The number of values in qValues and the value of qNoOfMatches are equal if qMaxNbrFieldMatches is -1.
-
-
- qTotalSearchResults integer
Total number of search results. This number is not limited by qPage/qCount .
-
Errors
arraySearchAssociations(qOptions, qTerms, qPage)
const result = await doc.searchAssociations({ "qSearchFields": [ "value" ], "qContext": "Cleared", "qCharEncoding": "Utf8", "qAttributes": [ "value" ]}, [ "value"], { "qOffset": 123, "qCount": 123, "qMaxNbrFieldMatches": -1, "qGroupOptions": [ { "qGroupType": "DatasetType", "qOffset": 0, "qCount": -1 } ], "qGroupItemOptions": [ { "qGroupItemType": "Field", "qOffset": 0, "qCount": -1 } ]})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SearchAssociations", "params": { "qOptions": { "qSearchFields": [ "value" ], "qContext": "Cleared", "qCharEncoding": "Utf8", "qAttributes": [ "value" ] }, "qTerms": [ "value" ], "qPage": { "qOffset": 123, "qCount": 123, "qMaxNbrFieldMatches": -1, "qGroupOptions": [ { "qGroupType": "DatasetType", "qOffset": 0, "qCount": -1 } ], "qGroupItemOptions": [ { "qGroupItemType": "Field", "qOffset": 0, "qCount": -1 } ] } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResults": { "qFieldNames": [ "value" ], "qSearchTerms": [ "value" ], "qFieldDictionaries": [ { "qField": 123, "qResult": [ { "qText": "value", "qElemNumber": 123, "qRanges": [ { "qCharPos": 123, "qCharCount": 123, "qTerm": 123 } ] } ] } ], "qSearchTermsMatched": [ [ { "qId": 123, "qFieldMatches": [ { "qField": 123, "qValues": [ 123 ], "qTerms": [ 123 ], "qNoOfMatches": 123 } ] } ] ], "qTotalSearchResults": 123 } }}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
- qOptions objectRequired
Information about attributes.
qOptions properties
- qAttributes array of strings
This array is either empty or contains qProperty .
- qCharEncoding string
Can be one of: "Utf8""Utf16"
-
- qTerms array of stringsRequired
Terms to search for.
- qPage objectRequired
Array of pages to retrieve.
qPage properties
- qOffset integer
Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0.
- 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 objects
Options of the search groups. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method.
qGroupOptions properties
- qGroupType string
Can be one of: "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.
-
- qGroupItemOptions array of objects
Options of the search group items. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method.
qGroupItemOptions properties
- qGroupItemType string
Can be one of: "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.
-
-
Response
- qResult object
qResult properties
- qSearchTerms array of strings
List of the search terms.
- qTotalNumberOfGroups integer
Total number of groups.
- qSearchGroupArray array of objects
List of search groups. The groups are numbered from the value of SearchPage.qOffset to the value of SearchPage.qOffset + SearchPage.qCount .
qSearchGroupArray properties
- qId integer
Identifier of the search group.
- qGroupType string
Can be one of: "DatasetType""GenericObjectsType"
- qSearchTermsMatched array of integers
Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .
- qTotalNumberOfItems integer
Total number of distinct items in the search group.
- qItems array of objects
List of items in the search group. The group items are numbered from the value of SearchGroupOptions.qOffset to the value of SearchGroupOptions.qOffset + SearchGroupOptions.qCount
qItems properties
- qItemType string
Can be one of: "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 objects
List of matches in the search group item. The group item matches are numbered from the value of SearchGroupItemOptions.qOffset to the value of SearchGroupItemOptions.qOffset + SearchGroupItemOptions.qCount .
qItemMatches properties
- qText string
Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value.
- qFieldSelectionMode string
Can be one of: "OneAndOnlyOne"
- qRanges array of objects
List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.
qRanges properties
- 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.
-
- qAttributes array of objects
Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty. For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains [“qProperty”, "qMetaDef/title”] if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” . For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains ["qNum", N] where N is the numeric value of the element or NaN if the value is not numeric. For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains ["qElemNum", N] where N is the value index of the element.
qAttributes properties
- qKey string
String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.
- qValue string
String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title.
-
-
- qSearchTermsMatched array of integers
Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .
- qMatchType string
Can be one of: "FieldMatchNone""FieldMatchSubString""FieldMatchWord""FieldMatchExact""FieldMatchLast"
-
-
-
Errors
arraySearchObjects(qOptions, qTerms, qPage)
const result = await doc.searchObjects({ "qAttributes": [ "value" ], "qCharEncoding": "Utf8"}, [ "value"], { "qOffset": 123, "qCount": 123, "qMaxNbrFieldMatches": -1, "qGroupOptions": [ { "qGroupType": "DatasetType", "qOffset": 0, "qCount": -1 } ], "qGroupItemOptions": [ { "qGroupItemType": "Field", "qOffset": 0, "qCount": -1 } ]})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SearchObjects", "params": { "qOptions": { "qAttributes": [ "value" ], "qCharEncoding": "Utf8" }, "qTerms": [ "value" ], "qPage": { "qOffset": 123, "qCount": 123, "qMaxNbrFieldMatches": -1, "qGroupOptions": [ { "qGroupType": "DatasetType", "qOffset": 0, "qCount": -1 } ], "qGroupItemOptions": [ { "qGroupItemType": "Field", "qOffset": 0, "qCount": -1 } ] } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": { "qSearchTerms": [ "value" ], "qTotalNumberOfGroups": 123, "qSearchGroupArray": [ { "qId": 123, "qGroupType": "DatasetType", "qSearchTermsMatched": [ 123 ], "qTotalNumberOfItems": 123, "qItems": [ { "qItemType": "Field", "qTotalNumberOfMatches": 123, "qIdentifier": "value", "qItemMatches": [ { "qText": "value", "qFieldSelectionMode": "OneAndOnlyOne", "qRanges": [ { "qCharPos": 123, "qCharCount": 123, "qTerm": 123 } ], "qAttributes": [ { "qKey": "value", "qValue": "value" } ] } ], "qSearchTermsMatched": [ 123 ], "qMatchType": "FieldMatchNone" } ] } ] } }}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
- qOptions objectRequired
Information about the search combinations.
qOptions properties
- qSearchFields array of strings
List of the search fields. If empty, the search is performed in all fields of the app.
- qContext string
Can be one of: "Cleared""LockedFieldsOnly""CurrentSelections"
- qCharEncoding string
Can be one of: "Utf8""Utf16"
- qAttributes array of strings
Optional.
- For SearchSuggest method, this array is empty.
- For SearchObjects method, this array is empty or contain qProperty .
- For SearchResults method, this array is empty, or contains qNum and/or qElemNum . It allows the user to request details in the outputted SearchGroupItemMatch . For more information, see SearchGroupItemMatch.
-
- qTerms array of stringsRequired
Terms to search for.
- qPage objectRequired
Array of pages to retrieve.
qPage properties
- qOffset integer
Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0.
- 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 objects
Options of the search groups. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method.
qGroupOptions properties
- qGroupType string
Can be one of: "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.
-
- qGroupItemOptions array of objects
Options of the search group items. If this property is not set, all values are returned. This property is to be used with the SearchResults method or the SearchObjects method.
qGroupItemOptions properties
- qGroupItemType string
Can be one of: "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.
-
-
Response
- qResult object
qResult properties
- qSearchTerms array of strings
List of the search terms.
- qTotalNumberOfGroups integer
Total number of groups.
- qSearchGroupArray array of objects
List of search groups. The groups are numbered from the value of SearchPage.qOffset to the value of SearchPage.qOffset + SearchPage.qCount .
qSearchGroupArray properties
- qId integer
Identifier of the search group.
- qGroupType string
Can be one of: "DatasetType""GenericObjectsType"
- qSearchTermsMatched array of integers
Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .
- qTotalNumberOfItems integer
Total number of distinct items in the search group.
- qItems array of objects
List of items in the search group. The group items are numbered from the value of SearchGroupOptions.qOffset to the value of SearchGroupOptions.qOffset + SearchGroupOptions.qCount
qItems properties
- qItemType string
Can be one of: "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 objects
List of matches in the search group item. The group item matches are numbered from the value of SearchGroupItemOptions.qOffset to the value of SearchGroupItemOptions.qOffset + SearchGroupItemOptions.qCount .
qItemMatches properties
- qText string
Search match value. Value of the search group item. If the match is found in a field, it corresponds to the value of the field. If the match is found in a generic object property, it corresponds to the property value.
- qFieldSelectionMode string
Can be one of: "OneAndOnlyOne"
- qRanges array of objects
List of ranges. For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.
qRanges properties
- 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.
-
- qAttributes array of objects
Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty. For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains [“qProperty”, "qMetaDef/title”] if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” . For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains ["qNum", N] where N is the numeric value of the element or NaN if the value is not numeric. For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains ["qElemNum", N] where N is the value index of the element.
qAttributes properties
- qKey string
String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.
- qValue string
String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title.
-
-
- qSearchTermsMatched array of integers
Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .
- qMatchType string
Can be one of: "FieldMatchNone""FieldMatchSubString""FieldMatchWord""FieldMatchExact""FieldMatchLast"
-
-
-
Errors
arraySearchResults(qOptions, qTerms, qPage)
const result = await doc.searchResults({ "qSearchFields": [ "value" ], "qContext": "Cleared", "qCharEncoding": "Utf8", "qAttributes": [ "value" ]}, [ "value"], { "qOffset": 123, "qCount": 123, "qMaxNbrFieldMatches": -1, "qGroupOptions": [ { "qGroupType": "DatasetType", "qOffset": 0, "qCount": -1 } ], "qGroupItemOptions": [ { "qGroupItemType": "Field", "qOffset": 0, "qCount": -1 } ]})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SearchResults", "params": { "qOptions": { "qSearchFields": [ "value" ], "qContext": "Cleared", "qCharEncoding": "Utf8", "qAttributes": [ "value" ] }, "qTerms": [ "value" ], "qPage": { "qOffset": 123, "qCount": 123, "qMaxNbrFieldMatches": -1, "qGroupOptions": [ { "qGroupType": "DatasetType", "qOffset": 0, "qCount": -1 } ], "qGroupItemOptions": [ { "qGroupItemType": "Field", "qOffset": 0, "qCount": -1 } ] } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": { "qSearchTerms": [ "value" ], "qTotalNumberOfGroups": 123, "qSearchGroupArray": [ { "qId": 123, "qGroupType": "DatasetType", "qSearchTermsMatched": [ 123 ], "qTotalNumberOfItems": 123, "qItems": [ { "qItemType": "Field", "qTotalNumberOfMatches": 123, "qIdentifier": "value", "qItemMatches": [ { "qText": "value", "qFieldSelectionMode": "OneAndOnlyOne", "qRanges": [ { "qCharPos": 123, "qCharCount": 123, "qTerm": 123 } ], "qAttributes": [ { "qKey": "value", "qValue": "value" } ] } ], "qSearchTermsMatched": [ 123 ], "qMatchType": "FieldMatchNone" } ] } ] } }}Returns search terms suggestions.
Parameters
- qOptions objectRequired
Information about the search combinations.
qOptions properties
- qSearchFields array of strings
List of the search fields. If empty, the search is performed in all fields of the app.
- qContext string
Can be one of: "Cleared""LockedFieldsOnly""CurrentSelections"
- qCharEncoding string
Can be one of: "Utf8""Utf16"
- qAttributes array of strings
Optional.
- For SearchSuggest method, this array is empty.
- For SearchObjects method, this array is empty or contain qProperty .
- For SearchResults method, this array is empty, or contains qNum and/or qElemNum . It allows the user to request details in the outputted SearchGroupItemMatch . For more information, see SearchGroupItemMatch.
-
- qTerms array of stringsRequired
Terms to search for.
Response
- qResult object
qResult properties
- qSuggestions array of objects
List of suggestions.
qSuggestions properties
- qValue string
Value of the suggestion.
- qTerm integer
Index of the suggestion value. The indexing starts from 0 and from the left.
-
- qFieldNames array of strings
List of field names that contain search hits.
-
Errors
arraySearchSuggest(qOptions, qTerms)
const result = await doc.searchSuggest({ "qSearchFields": [ "value" ], "qContext": "Cleared", "qCharEncoding": "Utf8", "qAttributes": [ "value" ]}, [ "value"])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SearchSuggest", "params": { "qOptions": { "qSearchFields": [ "value" ], "qContext": "Cleared", "qCharEncoding": "Utf8", "qAttributes": [ "value" ] }, "qTerms": [ "value" ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": { "qSuggestions": [ { "qValue": "value", "qTerm": 123 } ], "qFieldNames": [ "value" ] } }}Parameters
- qOptions objectRequired Experimental
qOptions properties
- qSearchFields array of strings
List of the search fields. If empty, the search is performed in all fields of the app.
-
- qTerms array of stringsRequired
- qPage objectRequired Experimental
qPage properties
- qOffset integer
Position from the top, starting from 0. If the offset is set to 0, the first search result to be returned is at position 0.
- qCount integer
Number of search fields to return
- qMaxNbrFieldMatches integer
Maximum number of matching values to return per search result.
-
Response
- qResult objectExperimental
qResult properties
- qSearchTerms array of strings
List of the search terms.
- qFieldMatches array of objectsExperimental
List of search groups. The groups are numbered from the value of SearchPage.qOffset to the value of SearchPage.qOffset + SearchPage.qCount .
qFieldMatches properties
- qFieldName string
Field name of matches.
- qValues array of objectsExperimental
List of search matches.
qValues properties
- qText string
- qElemNo integer
- qSearchTermsMatched array of integers
-
-
-
Errors
arraySearchValues(qOptions, qTerms, qPage)
const result = await doc.searchValues({ "qSearchFields": [ "value" ]}, [ "value"], { "qOffset": 123, "qCount": 123, "qMaxNbrFieldMatches": -1})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SearchValues", "params": { "qOptions": { "qSearchFields": [ "value" ] }, "qTerms": [ "value" ], "qPage": { "qOffset": 123, "qCount": 123, "qMaxNbrFieldMatches": -1 } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": { "qSearchTerms": [ "value" ], "qFieldMatches": [ { "qFieldName": "value", "qValues": [ { "qText": "value", "qElemNo": 123, "qSearchTermsMatched": [ 123 ] } ] } ] } }}Selects all search hits for a specified group. The results depend on the search context. SearchCombinationOptions.
Parameters
- qOptions objectRequired
Information about the search fields and the search context.
qOptions properties
- qSearchFields array of strings
List of the search fields. If empty, the search is performed in all fields of the app.
- qContext string
Can be one of: "Cleared""LockedFieldsOnly""CurrentSelections"
- qCharEncoding string
Can be one of: "Utf8""Utf16"
- qAttributes array of strings
Optional.
- For SearchSuggest method, this array is empty.
- For SearchObjects method, this array is empty or contain qProperty .
- For SearchResults method, this array is empty, or contains qNum and/or qElemNum . It allows the user to request details in the outputted SearchGroupItemMatch . For more information, see SearchGroupItemMatch.
-
- qTerms array of stringsRequired
List of terms to search for.
- qMatchIx integerRequired
Index (value of qId ) of the search result to select.
- qSoftLock boolean
This parameter is deprecated and should not be set.
Response
objectErrors
arraySelectAssociations(qOptions, qTerms, qMatchIx, qSoftLock?)
const result = await doc.selectAssociations({ "qSearchFields": [ "value" ], "qContext": "Cleared", "qCharEncoding": "Utf8", "qAttributes": [ "value" ]}, [ "value"], 123, true)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SelectAssociations", "params": { "qOptions": { "qSearchFields": [ "value" ], "qContext": "Cleared", "qCharEncoding": "Utf8", "qAttributes": [ "value" ] }, "qTerms": [ "value" ], "qMatchIx": 123, "qSoftLock": true }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Doc SendGenericCommandToCustomConnector
(qProvider, qCommand, qMethod, qParameters, qAppendConnection)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
- qProvider stringRequired
Connector file name. Command to be executed by the connector.
- qCommand stringRequired
One of:
- JsonRequest
- GetCustomCaption
- IsConnected
- DisableQlikViewSelectButton
- HaveStarField
- qMethod stringRequired
Method name to be used within the command. The available methods depend on the chosen connector.
- qParameters array of stringsRequired
Parameters of the command. No parameters are required.
- qAppendConnection stringRequired
Name of the connection.
Response
- qResult string
Errors
arraySendGenericCommandToCustomConnector(qProvider, qCommand, qMethod, qParameters, qAppendConnection)
const result = await doc.sendGenericCommandToCustomConnector("value", "value", "value", [ "value"], "value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SendGenericCommandToCustomConnector", "params": { "qProvider": "value", "qCommand": "value", "qMethod": "value", "qParameters": [ "value" ], "qAppendConnection": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": "value" }}Sets properties to an app.
Parameters
- qProp objectRequired
Information about the properties of an app.
qProp properties
- qTitle string
App title.
- qLastReloadTime string
Last reload time of the app.
- qMigrationHash string
Internal property reserved for app migration. Patch version of the app. Do not update.
- qSavedInProductVersion string
Internal property reserved for app migration. The app is saved in this version of the product. Do not update.
- qThumbnail objectIn addition, this structure can contain dynamic properties.
qThumbnail properties
- qUrl string
Relative path of the thumbnail.
-
- qHasSectionAccess boolean
If true the app has section access configured.
- qUsage string
Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP""DIRECT_QUERY_MODE"
-
Response
objectErrors
arraySetAppProperties(qProp)
const result = await doc.setAppProperties({ "qTitle": "value", "qLastReloadTime": "value", "qMigrationHash": "value", "qSavedInProductVersion": "value", "qThumbnail": { "qUrl": "value" }, "qHasSectionAccess": true, "qUsage": "ANALYTICS"})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetAppProperties", "params": { "qProp": { "qTitle": "value", "qLastReloadTime": "value", "qMigrationHash": "value", "qSavedInProductVersion": "value", "qThumbnail": { "qUrl": "value" }, "qHasSectionAccess": true, "qUsage": "ANALYTICS" } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Set some variables as favorite.
Parameters
- qNames array of stringsRequired
Variables to set as favorite.
Response
objectErrors
arraySetFavoriteVariables(qNames)
const result = await doc.setFavoriteVariables([ "value"])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetFavoriteVariables", "params": { "qNames": [ "value" ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Limits the number of rows of data to load from a data source. This method works when reloading in debug mode.
Parameters
- qLimit integerRequired
Fetch limit. Number of rows to load.
Response
objectErrors
arraySetFetchLimit(qLimit)
const result = await doc.setFetchLimit(123)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetFetchLimit", "params": { "qLimit": 123 }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}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.
Parameters
- qv array of integersRequired
The list of table states to set. A state will not be changed if already set to 2.
Response
- qReturn boolean
Errors
arraySetLooselyCoupledVector(qv)
const result = await doc.setLooselyCoupledVector([ 123])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetLooselyCoupledVector", "params": { "qv": [ 123 ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}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
- qProhibit booleanRequired
True or false.
Response
objectErrors
arraySetProhibitBinaryLoad(qProhibit)
const result = await doc.setProhibitBinaryLoad(true)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetProhibitBinaryLoad", "params": { "qProhibit": true }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Sets values in script.
Parameters
- qScript stringRequired
Script content.
Response
objectErrors
arraySetScript(qScript)
const result = await doc.setScript("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetScript", "params": { "qScript": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Set some breakpoints in the script of an app.
Parameters
- qBreakpoints array of objectsRequired
Information about the breakpoints.
qBreakpoints properties
- 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).
-
Response
objectErrors
arraySetScriptBreakpoints(qBreakpoints)
const result = await doc.setScriptBreakpoints([ { "qbufferName": "value", "qlineIx": 123, "qEnabled": true }])Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetScriptBreakpoints", "params": { "qBreakpoints": [ { "qbufferName": "value", "qlineIx": 123, "qEnabled": true } ] }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Sets the positions of the tables in the data model viewer.
Parameters
- qInfo objectRequired
Information about the table.
qInfo properties
- qPos object
qPos properties
- 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 ).
-
- qCtlInfo object
qCtlInfo properties
- qInternalView object
qInternalView properties
- qTables array of objects
List of the tables in the database model viewer.
qTables properties
- qPos object
qPos properties
- 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 ).
-
- qCaption string
Table name.
-
- qBroomPoints array of objects
List of the broom points in the database model viewer. Not used in Qlik Sense.
qBroomPoints properties
- qPos object
qPos properties
- 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.
-
- qTable string
Name of the table.
- qFields array of strings
List of fields in the table.
-
- qConnectionPoints array of objects
List of connection points in the database model viewer. Not used in Qlik Sense.
qConnectionPoints properties
- qPos object
qPos properties
- 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.
-
- qFields array of strings
List of the fields in the table.
-
- qZoomFactor number
Zoom factor in the database model viewer. The default value is 1.0.
-
- qSourceView object
qSourceView properties
- qTables array of objects
List of the tables in the database model viewer.
qTables properties
- qPos object
qPos properties
- 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 ).
-
- qCaption string
Table name.
-
- qBroomPoints array of objects
List of the broom points in the database model viewer. Not used in Qlik Sense.
qBroomPoints properties
- qPos object
qPos properties
- 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.
-
- qTable string
Name of the table.
- qFields array of strings
List of fields in the table.
-
- qConnectionPoints array of objects
List of connection points in the database model viewer. Not used in Qlik Sense.
qConnectionPoints properties
- qPos object
qPos properties
- 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.
-
- qFields array of strings
List of the fields in the table.
-
- qZoomFactor number
Zoom factor in the database model viewer. The default value is 1.0.
-
-
- 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.
-
Response
objectErrors
arraySetViewDlgSaveInfo(qInfo)
const result = await doc.setViewDlgSaveInfo({ "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCtlInfo": { "qInternalView": { "qTables": [ { "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCaption": "value" } ], "qBroomPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qTable": "value", "qFields": [ "value" ] } ], "qConnectionPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qFields": [ "value" ] } ], "qZoomFactor": 1 }, "qSourceView": { "qTables": [ { "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCaption": "value" } ], "qBroomPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qTable": "value", "qFields": [ "value" ] } ], "qConnectionPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qFields": [ "value" ] } ], "qZoomFactor": 1 } }, "qMode": 123})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetViewDlgSaveInfo", "params": { "qInfo": { "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCtlInfo": { "qInternalView": { "qTables": [ { "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCaption": "value" } ], "qBroomPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qTable": "value", "qFields": [ "value" ] } ], "qConnectionPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qFields": [ "value" ] } ], "qZoomFactor": 1 }, "qSourceView": { "qTables": [ { "qPos": { "qLeft": 123, "qTop": 123, "qWidth": 123, "qHeight": 123 }, "qCaption": "value" } ], "qBroomPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qTable": "value", "qFields": [ "value" ] } ], "qConnectionPoints": [ { "qPos": { "qx": 123, "qy": 123 }, "qFields": [ "value" ] } ], "qZoomFactor": 1 } }, "qMode": 123 } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}Store current selection state temporarily.
Parameters
- qTTLOfTempState integer
Time to live in seconds for stored selection state
Response
- qId string
- qReturn boolean
Errors
arrayStoreTempSelectionState(qTTLOfTempState?)
const result = await doc.storeTempSelectionState(123)Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "StoreTempSelectionState", "params": { "qTTLOfTempState": 123 }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qId": "value", "qReturn": true }}Transform current app into an instance of the targeted mode
Parameters
- qDstParameters objectRequired
Attributes that should be set in the new app.
qDstParameters properties
- qName string
The name (title) of the application
- qSpaceId string
ID of the space where the app is to be created. Empty value implies Personal space
- qScriptParameterPrefix string
Prefix to be used on inserted ScriptParameters, only applicable for template apps
-
Response
- qResult object
qResult properties
- qAppId string
ID of created App
-
Errors
arrayTransformApp(qDstParameters)
const result = await doc.transformApp({ "qName": "value", "qSpaceId": "value", "qScriptParameterPrefix": "value"})Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "TransformApp", "params": { "qDstParameters": { "qName": "value", "qSpaceId": "value", "qScriptParameterPrefix": "value" } }}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qResult": { "qAppId": "value" } }}Undoes the previous operation.
Response
- qSuccess boolean
Errors
arrayUndo()
const result = await doc.undo()Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Undo"}Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qSuccess": true }}Unlocks all selections in fields for current state.
Parameters
- qStateName string
Alternate state name. When set, applies to alternate state instead of current.
Response
objectErrors
arrayUnlockAll(qStateName?)
const result = await doc.unlockAll("value")Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "UnlockAll", "params": { "qStateName": "value" }}Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}