Qlik Sense Engine (qix)
The JSON-RPC API over WebSocket API that enables you to interact with the Qlik Associative Engine for Qlik Sense applications.
GenericObject
Aborts the results of a search in a list object.
Parameters
- qPathstringRequired
Path to the definition of the list object. For example, /qListObjectDef .
Response
objectErrors
arrayAbortListObjectSearch(qPath)
const result = await genericObject.AbortListObjectSearch([
"value"
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "AbortListObjectSearch",
"params": {
"qPath": "value"
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Accept the results of a search in a list object. The search results become selected in the field.
Parameters
- qPathstringRequired
Path to the definition of the list object. For example, /qListObjectDef .
- qToggleModebooleanRequired
Set to true to keep any selections present in the list object. If this parameter is set to false, selections made before accepting the list object search become alternative.
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
objectErrors
arrayAcceptListObjectSearch(qPath, qToggleMode, qSoftLock?)
const result = await genericObject.AcceptListObjectSearch([
"value",
true,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "AcceptListObjectSearch",
"params": {
"qPath": "value",
"qToggleMode": true,
"qSoftLock": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Applies a patch to the properties of an object. Allows an update to some of the properties. It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch. In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties , and only a GetLayout call shows the result of the operation. Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future.
Parameters
- qPatchesarray of objectsRequired
Array of patches.
qPatches properties
- qOpstring
Can be one of: "add""remove""replace"
- qPathstring
Path to the property to add, remove or replace.
- qValuestring
This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
-
- qSoftPatchboolean
If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch. The default value is false.
Response
objectErrors
arrayApplyPatches(qPatches, qSoftPatch?)
const result = await genericObject.ApplyPatches([
[
{
"qOp": "add",
"qPath": "value",
"qValue": "value"
}
],
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "ApplyPatches",
"params": {
"qPatches": [
{
"qOp": "add",
"qPath": "value",
"qValue": "value"
}
],
"qSoftPatch": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Adds the generic object to the list of approved objects
Response
objectErrors
arrayApprove()
const result = await genericObject.Approve({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "Approve"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Begins the selection mode. The app enters the modal state. The specified object enters the selection mode and a modal window is opened. The selection mode can apply to only one object in an app at a time. When a visualization is in selection mode, selections can be made in this visualization. The visualization is not sorted until the selection mode is ended. Once the selection mode is ended and if the selections are accepted, the visualization is sorted according to the sort criteria. For more information about:
- Ending the selection mode, see EndSelections Method.
- The sort criteria, see ListObjectDef or HyperCubeDef.
Example
A sheet contains a list object and a chart. If the list object is in selection mode then the chart cannot be in selection mode. No selection on the chart can be made until the list object exits the selection mode.
Parameters
- qPathsarray of stringsRequired
List of the paths to the definition of the objects to enter selection mode. For example, /qListObjectDef .
Response
objectErrors
arrayBeginSelections(qPaths)
const result = await genericObject.BeginSelections([
[
"value"
]
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "BeginSelections",
"params": {
"qPaths": [
"value"
]
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Clears the selections in a dimension of a visualization.
Parameters
- qPathstringRequired
Path to the definition of the visualization. For example, /qListObjectDef .
- qColIndicesarray of integers
Array of dimension numbers or indexes. The selections are cleared in the specified dimensions. Dimension numbers/indexes start from 0. If this parameter is not set, all dimensions are cleared.
Response
objectErrors
arrayClearSelections(qPath, qColIndices?)
const result = await genericObject.ClearSelections([
"value",
[
123
]
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "ClearSelections",
"params": {
"qPath": "value",
"qColIndices": [
123
]
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Clears the soft properties of a generic object. For more information on how to add soft properties to a generic object, see ApplyPatches Method.
Response
objectErrors
arrayClearSoftPatches()
const result = await genericObject.ClearSoftPatches({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "ClearSoftPatches"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Collapses the left dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded. In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.
Parameters
- qPathstringRequired
Path to the definition of the object to be collapsed. For example, /qHyperCubeDef .
- qRowintegerRequired
Row index in the data matrix. Indexing starts from 0.
- qColintegerRequired
Column index. The index is based on the left dimension indexes. Indexing starts from 0.
- qAllbooleanRequired
If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).
Response
objectErrors
arrayCollapseLeft(qPath, qRow, qCol, qAll)
const result = await genericObject.CollapseLeft([
"value",
123,
123,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "CollapseLeft",
"params": {
"qPath": "value",
"qRow": 123,
"qCol": 123,
"qAll": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Collapses the top dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded. In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.
Parameters
- qPathstringRequired
Path to the definition of the object to be collapsed For example, /qHyperCubeDef .
- qRowintegerRequired
Row index. The index is based on the top dimension indexes. Indexing starts from 0.
- qColintegerRequired
Column index in the data matrix. Indexing starts from 0.
- qAllbooleanRequired
If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).
Response
objectErrors
arrayCollapseTop(qPath, qRow, qCol, qAll)
const result = await genericObject.CollapseTop([
"value",
123,
123,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "CollapseTop",
"params": {
"qPath": "value",
"qRow": 123,
"qCol": 123,
"qAll": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Copies the properties of a generic object and its children. The source object is specified by the parameter qFromId and the destination object is referenced by its handle.
Parameters
- qFromIdstringRequired
Identifier of the object to copy.
Response
objectErrors
arrayCopyFrom(qFromId)
const result = await genericObject.CopyFrom([
"value"
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "CopyFrom",
"params": {
"qFromId": "value"
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Creates a generic object that is a child of another generic object.
Parameters
- qPropobjectRequired
Information about the child. It is possible to create a child that is linked to another object.
qProp properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
- qPropForThisobject
Identifier of the parent's object. Should be set to update the properties of the parent's object at the same time the child is created.
qPropForThis properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
Response
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qReturnobject
qReturn properties
- qTypestring
The native type of the object.
- qHandleinteger
The handle used to connect to object.
- qGenericTypestring
The type of the object.
- qGenericIdstring
Object ID.
-
Errors
arrayCreateChild(qProp, qPropForThis?)
const result = await genericObject.CreateChild([
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
},
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "CreateChild",
"params": {
"qProp": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
},
"qPropForThis": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qReturn": {
"qType": "value",
"qHandle": 123,
"qGenericType": "value",
"qGenericId": "value"
}
}
}
Removes all children and all children to the children on an object.
Parameters
- qPropForThisobject
Identifier of the parent's object and property to update. Should be set to update the properties of the parent's object at the same time the child is created.
qPropForThis properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
Response
objectErrors
arrayDestroyAllChildren(qPropForThis?)
const result = await genericObject.DestroyAllChildren([
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "DestroyAllChildren",
"params": {
"qPropForThis": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Removes a child object.
Parameters
- qIdstringRequired
Identifier of the child to remove.
- qPropForThisobject
Identifier of the parent's object and property to update. Should be set to update the properties of the parent's object at the same time the child is created.
qPropForThis properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
Response
- qSuccessboolean
Errors
arrayDestroyChild(qId, qPropForThis?)
const result = await genericObject.DestroyChild([
"value",
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "DestroyChild",
"params": {
"qId": "value",
"qPropForThis": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
You can use the drillUp method with any object that contains a drill-down group as a dimension. This method allows you to move between different levels of information (from a detailed level to a less detailed level of information). You can go back to previous visualizations up to the highest level of the hierarchy. If you try to drill up more steps than there are available levels, the first level of the hierarchy is displayed.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qDimNointegerRequired
Dimension number or index starting from 0. The default value is 0.
- qNbrStepsintegerRequired
Number of steps you want to drill up. The default value is 0.
Response
objectErrors
arrayDrillUp(qPath, qDimNo, qNbrSteps)
const result = await genericObject.DrillUp([
"value",
123,
123
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "DrillUp",
"params": {
"qPath": "value",
"qDimNo": 123,
"qNbrSteps": 123
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Adds a snapshot to a generic object.
Parameters
- qIdstringRequired
Identifier of the bookmark.
Response
objectErrors
arrayEmbedSnapshotObject(qId)
const result = await genericObject.EmbedSnapshotObject([
"value"
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "EmbedSnapshotObject",
"params": {
"qId": "value"
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Ends the selection mode on a visualization. The selections are accepted or aborted when exiting the selection mode, depending on the qAccept parameter value.
Parameters
- qAcceptbooleanRequired
Set this parameter to true to accept the selections before exiting the selection mode.
Response
objectErrors
arrayEndSelections(qAccept)
const result = await genericObject.EndSelections([
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "EndSelections",
"params": {
"qAccept": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Expands the left dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded. In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.
Parameters
- qPathstringRequired
Path to the definition of the object to be expanded. For example, /qHyperCubeDef .
- qRowintegerRequired
Row index in the data matrix to expand. Indexing starts from 0.
- qColintegerRequired
Column index. The index is based on the left dimension indexes. Indexing starts from 0.
- qAllbooleanRequired
If set to true, it expands all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).
Response
objectErrors
arrayExpandLeft(qPath, qRow, qCol, qAll)
const result = await genericObject.ExpandLeft([
"value",
123,
123,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "ExpandLeft",
"params": {
"qPath": "value",
"qRow": 123,
"qCol": 123,
"qAll": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Expands the top dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded. In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.
Parameters
- qPathstringRequired
Path to the definition of the object to be expanded. For example, /qHyperCubeDef .
- qRowintegerRequired
Row index. The index is based on the top dimension indexes. Indexing starts from 0.
- qColintegerRequired
Column index in the data matrix. Indexing starts from 0.
- qAllbooleanRequired
If set to true, it expands all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).
Response
objectErrors
arrayExpandTop(qPath, qRow, qCol, qAll)
const result = await genericObject.ExpandTop([
"value",
123,
123,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "ExpandTop",
"params": {
"qPath": "value",
"qRow": 123,
"qCol": 123,
"qAll": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported. This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.
Default limitations in number of rows and columns
The default maximum number of rows and columns in the Excel export file is:
- 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.
- 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.
Default limitation in number of columns
The default maximum number of columns in the export file is:
- 1000 to export to a CSV file
Default limitations in number of cells
The default maximum number of cells in the export file is:
- 5000000 to export to a CSV file
The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.
Default limitation in size
If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.
Parameters
- qFileTypestringRequired
Type of the file to export.
One of:
- CSV_C or EXPORT_CSV_C
- CSV_T or EXPORT_CSV_T
- OOXML or EXPORT_OOXML
- PARQUET or EXPORT_PARQUET
- qPathstring
Path to the definition of the object to be exported. For example, /qHyperCubeDef . This parameter is mandatory if the file type is CSV_C or CSV_T .
- qFileNamestring
Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop.
- qExportStatestring
Defines the values to be exported. The default value is A.
One of:
- P or EXPORT_POSSIBLE
- A or EXPORT_ALL
- qServeOnceboolean
If the exported file should be served only once This parameter is optional and only used in Qlik Sense Enterprise (Windows) Default value: false
Response
- qUrlstring
- qWarningsarray of integers
Errors
arrayExportData(qFileType, qPath?, qFileName?, qExportState?, qServeOnce?)
const result = await genericObject.ExportData([
"value",
"value",
"value",
"value",
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "ExportData",
"params": {
"qFileType": "value",
"qPath": "value",
"qFileName": "value",
"qExportState": "value",
"qServeOnce": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qUrl": "value",
"qWarnings": [
123
]
}
}
Returns the type of the object and the corresponding handle.
Parameters
- qIdstringRequired
Identifier of the object.
Response
- qReturnobject
qReturn properties
- qTypestring
The native type of the object.
- qHandleinteger
The handle used to connect to object.
- qGenericTypestring
The type of the object.
- qGenericIdstring
Object ID.
-
Errors
arrayGetChild(qId)
const result = await genericObject.GetChild([
"value"
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetChild",
"params": {
"qId": "value"
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qReturn": {
"qType": "value",
"qHandle": 123,
"qGenericType": "value",
"qGenericId": "value"
}
}
}
Returns the identifier and the type for each child in an app object. If the child contains extra properties in qInfos , these properties are returned.
Full dynamic properties are optional and are returned if they exist in the definition of the object.
Response
- qInfosarray of objects
qInfos properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
Errors
arrayGetChildInfos()
const result = await genericObject.GetChildInfos({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetChildInfos"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qInfos": [
{
"qId": "value",
"qType": "value"
}
]
}
}
Returns the identifier, the type and the properties of the object. If the object contains some soft properties, the soft properties are returned. If the object is linked to another object, the properties of the linking object are returned.
Response
- qPropobject
qProp properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
Errors
arrayGetEffectiveProperties()
const result = await genericObject.GetEffectiveProperties({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetEffectiveProperties"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qProp": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
}
}
Gets the properties of:
- A generic object.
- The children of the generic object.
- The bookmarks/embedded snapshots of the generic object.
Response
- qPropEntryobject
qPropEntry properties
- qPropertyobject
qProperty properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
- qChildrenarray of undefineds
Information about the children of the generic object.
- qEmbeddedSnapshotRefobject
qEmbeddedSnapshotRef properties
- qPropertiesobject
qProperties properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qIncludeVariablesbooleanExperimental
If true all variables will be stored in the bookmark.
- qDistinctValuesbooleanExperimental
If true all selected values will be stored distinct, i.e. searchstrings will not be kept.
-
- qBookmarkobject
qBookmark properties
- qStateDataarray of objects
List of selections for each state.
qStateData properties
- qStateNamestring
Name of the alternate state. Default is current selections: $
- qFieldItemsarray of objects
List of the selections.
qFieldItems properties
- qDefobject
qDef properties
- qNamestring
Name of the field.
- qTypestring
Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"
-
- qLockedboolean
Indicates if the field is locked. Default is false.
- qSelectInfoobject
qSelectInfo properties
- qTextSearchstring
Text search string. Everything that matches the text is selected. This parameter is optional.
- qRangeLonumber
Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qRangeHinumber
Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qNumberFormatobject
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberFormat properties
- qTypestring
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDecinteger
Number of decimals. Default is 10.
- qUseThouinteger
Defines whether or not a thousands separator must be used. Default is 0.
- qFmtstring
Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
- qDecstring
Defines the decimal separator. Example: .
- qThoustring
Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
- qRangeInfoarray of objects
This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.
qRangeInfo properties
- qRangeLonumber
Lowest value in the range.
- qRangeHinumber
Highest value in the range.
- qMeasurestring
Label of the measure.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
- qContinuousRangeInfoarray of objects
List of information about ranges for selections.
qContinuousRangeInfo properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qSelectFieldSearchboolean
This parameter is true if the TextSearch is a result of a Select Field operation.
-
- qValuesarray of objects
qValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qExcludedValuesarray of objects
List of excluded values. Either the list of selected values or the list of excluded values is displayed.
qExcludedValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qAndModeboolean
If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.
- qOneAndOnlyOneboolean
If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.
-
-
- qUtcModifyTimenumber
Time when the bookmark was created.
- qVariableItemsarray of objects
List of the variables in the app at the time the bookmark was created.
qVariableItems properties
- qNamestring
Name of the variable.
- qValueobject
qValue properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qDefinitionstring
The Reporting mode definition of the variable.
-
- qPatchesarray of objects
Softpatches to be applied with this bookmark.
qPatches properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qPatchesarray of objects
Array with patches.
qPatches properties
- qOpstring
Can be one of: "add""remove""replace"
- qPathstring
Path to the property to add, remove or replace.
- qValuestring
This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
-
- qChildrenarray of undefineds
Array with child objects and their patches.
-
- qCyclicGroupStatesarray of objects
Information about cyclic groups by zero-based index. This field is unused.
qCyclicGroupStates properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qActiveFieldinteger
Active field of the cyclic group, identified by a zero-based index.
-
- qGroupStatesarray of objectsExperimental
Information about cyclic groups indexed by field definition.
qGroupStates properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qActiveFieldDefstring
String defining the active field.
-
-
- qClassicBookmarkobject
qClassicBookmark properties
- qIdstring
- qNamestring
- qUtcModifyTimenumber
- qUtcRecallTimenumber
- qRecallCountinteger
- qApplyAdditiveboolean
- qFieldItemsarray of objects
qFieldItems properties
- qDefobject
qDef properties
- qNamestring
Name of the field.
- qTypestring
Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"
-
- qLockedboolean
Indicates if the field is locked. Default is false.
- qSelectInfoobject
qSelectInfo properties
- qTextSearchstring
Text search string. Everything that matches the text is selected. This parameter is optional.
- qRangeLonumber
Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qRangeHinumber
Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qNumberFormatobject
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberFormat properties
- qTypestring
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDecinteger
Number of decimals. Default is 10.
- qUseThouinteger
Defines whether or not a thousands separator must be used. Default is 0.
- qFmtstring
Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
- qDecstring
Defines the decimal separator. Example: .
- qThoustring
Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
- qRangeInfoarray of objects
This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.
qRangeInfo properties
- qRangeLonumber
Lowest value in the range.
- qRangeHinumber
Highest value in the range.
- qMeasurestring
Label of the measure.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
- qContinuousRangeInfoarray of objects
List of information about ranges for selections.
qContinuousRangeInfo properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qSelectFieldSearchboolean
This parameter is true if the TextSearch is a result of a Select Field operation.
-
- qValuesarray of objects
qValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qExcludedValuesarray of objects
List of excluded values. Either the list of selected values or the list of excluded values is displayed.
qExcludedValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qAndModeboolean
If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.
- qOneAndOnlyOneboolean
If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.
-
- qVariableItemsarray of objects
qVariableItems properties
- qNamestring
Name of the variable.
- qValueobject
qValue properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qDefinitionstring
The Reporting mode definition of the variable.
-
- qSheetIdstring
- qObjectsarray of objects
qObjects properties
- qIdstring
- qActiveboolean
- qShowModeinteger
- qScrollPosobject
qScrollPos properties
- qUsePositionboolean
- qPosobject
qPos properties
- qxinteger
x-coordinate in pixels. The origin is the top left of the screen.
- qyinteger
y-coordinate in pixels. The origin is the top left of the screen.
-
-
-
- qApplyLayoutStateboolean
- qShowPopupInfoboolean
- qInfoTextstring
- qOwnerstring
- qGroupsarray of objects
qGroups properties
- qIdstring
- qCyclePosinteger
-
- qShowobject
qShow properties
- qAlwaysboolean
- qExpressionobject
qExpression properties
- qvstring
Expression evaluated to dual.
-
-
- qApplyInputFieldValuesboolean
- qInputFieldItemsarray of objects
qInputFieldItems properties
- qFieldNamestring
- qValuesarray of objects
qValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qPackedHashKeysarray of integers
-
- qObjectsLayoutarray of objects
qObjectsLayout properties
- qIdstring
- qActiveboolean
- qShowModeinteger
- qScrollPosobject
qScrollPos properties
- qUsePositionboolean
- qPosobject
qPos properties
- qxinteger
x-coordinate in pixels. The origin is the top left of the screen.
- qyinteger
y-coordinate in pixels. The origin is the top left of the screen.
-
-
- qExpansionInfoarray of objects
qExpansionInfo properties
- qExcludeListboolean
- qPosobject
qPos properties
- qDimNamestring
- qElemNoarray of integers
- qElemValuesarray of strings
-
-
- qLeftCollapsedboolean
- qTopCollapsedboolean
- qSortDataarray of objects
qSortData properties
- qNamestring
- qReversedboolean
-
- qDimensionGroupPosarray of objects
qDimensionGroupPos properties
- qGroupNamestring
- qCurrentItemNamestring
-
- qExpressionGroupPosarray of objects
qExpressionGroupPos properties
- qGroupNamestring
- qCurrentItemNamestring
-
- qUseGraphModeboolean
- qGraphModestring
Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"
- qActiveContainerChildObjectIdstring
- qExtendedPivotStateobject
qExtendedPivotState properties
- qExpressionPositioninteger
- qNumberOfLeftDimensionsinteger
- qDimensionNamesarray of strings
- qEnableConditionsarray of strings
-
-
- qIncludeSelectionStateboolean
- qIncludeScrollPositionboolean
- qAlternateStateDataarray of objects
qAlternateStateData properties
- qStateNamestring
Name of the alternate state. Default is current selections: $
- qFieldItemsarray of objects
List of the selections.
qFieldItems properties
- qDefobject
qDef properties
- qNamestring
Name of the field.
- qTypestring
Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"
-
- qLockedboolean
Indicates if the field is locked. Default is false.
- qSelectInfoobject
qSelectInfo properties
- qTextSearchstring
Text search string. Everything that matches the text is selected. This parameter is optional.
- qRangeLonumber
Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qRangeHinumber
Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qNumberFormatobject
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberFormat properties
- qTypestring
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDecinteger
Number of decimals. Default is 10.
- qUseThouinteger
Defines whether or not a thousands separator must be used. Default is 0.
- qFmtstring
Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
- qDecstring
Defines the decimal separator. Example: .
- qThoustring
Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
- qRangeInfoarray of objects
This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.
qRangeInfo properties
- qRangeLonumber
Lowest value in the range.
- qRangeHinumber
Highest value in the range.
- qMeasurestring
Label of the measure.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
- qContinuousRangeInfoarray of objects
List of information about ranges for selections.
qContinuousRangeInfo properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qSelectFieldSearchboolean
This parameter is true if the TextSearch is a result of a Select Field operation.
-
- qValuesarray of objects
qValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qExcludedValuesarray of objects
List of excluded values. Either the list of selected values or the list of excluded values is displayed.
qExcludedValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qAndModeboolean
If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.
- qOneAndOnlyOneboolean
If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.
-
-
- qForAnnotationsboolean
- qIncludeAllVariablesboolean
-
- qClassicMetadataobject
qClassicMetadata properties
- qSharedboolean
- qUtcModifyTimenumber
- qSheetIdstring
- qTemporaryboolean
- qRestrictedAccessboolean
- qAccessListarray of strings
- qPersonalEditionHash_OBSOLETEstring
- qHiddenboolean
- qLinkedToarray of strings
-
-
-
Errors
arrayGetFullPropertyTree()
const result = await genericObject.GetFullPropertyTree({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetFullPropertyTree"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qPropEntry": {
"qProperty": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
},
"qChildren": [],
"qEmbeddedSnapshotRef": {
"qProperties": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qMetaDef": {},
"qIncludeVariables": true,
"qDistinctValues": true
},
"qBookmark": {
"qStateData": [
{
"qStateName": "value",
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
]
}
],
"qUtcModifyTime": 123,
"qVariableItems": [
{
"qName": "value",
"qValue": {
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
},
"qDefinition": "value"
}
],
"qPatches": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qPatches": [
{
"qOp": "add",
"qPath": "value",
"qValue": "value"
}
],
"qChildren": []
}
],
"qCyclicGroupStates": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qActiveField": 123
}
],
"qGroupStates": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qActiveFieldDef": "value"
}
]
},
"qClassicBookmark": {
"qId": "value",
"qName": "value",
"qUtcModifyTime": 123,
"qUtcRecallTime": 123,
"qRecallCount": 123,
"qApplyAdditive": true,
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
],
"qVariableItems": [
{
"qName": "value",
"qValue": {
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
},
"qDefinition": "value"
}
],
"qSheetId": "value",
"qObjects": [
{
"qId": "value",
"qActive": true,
"qShowMode": 123,
"qScrollPos": {
"qUsePosition": true,
"qPos": {
"qx": 123,
"qy": 123
}
}
}
],
"qApplyLayoutState": true,
"qShowPopupInfo": true,
"qInfoText": "value",
"qOwner": "value",
"qGroups": [
{
"qId": "value",
"qCyclePos": 123
}
],
"qShow": {
"qAlways": true,
"qExpression": {
"qv": "value"
}
},
"qApplyInputFieldValues": true,
"qInputFieldItems": [
{
"qFieldName": "value",
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qPackedHashKeys": [
123
]
}
],
"qObjectsLayout": [
{
"qId": "value",
"qActive": true,
"qShowMode": 123,
"qScrollPos": {
"qUsePosition": true,
"qPos": {
"qx": 123,
"qy": 123
}
},
"qExpansionInfo": [
{
"qExcludeList": true,
"qPos": {
"qDimName": "value",
"qElemNo": [
123
],
"qElemValues": [
"value"
]
}
}
],
"qLeftCollapsed": true,
"qTopCollapsed": true,
"qSortData": [
{
"qName": "value",
"qReversed": true
}
],
"qDimensionGroupPos": [
{
"qGroupName": "value",
"qCurrentItemName": "value"
}
],
"qExpressionGroupPos": [
{
"qGroupName": "value",
"qCurrentItemName": "value"
}
],
"qUseGraphMode": true,
"qGraphMode": "GRAPH_MODE_BAR",
"qActiveContainerChildObjectId": "value",
"qExtendedPivotState": {
"qExpressionPosition": 123,
"qNumberOfLeftDimensions": 123,
"qDimensionNames": [
"value"
],
"qEnableConditions": [
"value"
]
}
}
],
"qIncludeSelectionState": true,
"qIncludeScrollPosition": true,
"qAlternateStateData": [
{
"qStateName": "value",
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
]
}
],
"qForAnnotations": true,
"qIncludeAllVariables": true
},
"qClassicMetadata": {
"qShared": true,
"qUtcModifyTime": 123,
"qSheetId": "value",
"qTemporary": true,
"qRestrictedAccess": true,
"qAccessList": [
"value"
],
"qPersonalEditionHash_OBSOLETE": "value",
"qHidden": true,
"qLinkedTo": [
"value"
]
}
}
}
}
}
GenericObject GetHyperCubeBinnedData
(qPath, qPages, qViewport, qDataRanges, qMaxNbrCells, qQueryLevel, qBinningMethod)This method supports data binning. When a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points. A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the qQueryLevel parameter) or coarsened (for zoom out). The grid of cells is adaptive (not static), meaning that it adapts to different length scales. The GetHyperCubeBinnedData method gives information about the adaptive grid and the values of the generic object. The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned. Dimension values and measure values are rendered at point level (highest detailed level).
Adaptive Grid
More details about the properties of the adaptive grid are given in this paragraph. When the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays. The first array contains the following properties:
| Name | Description | Type |
|---|---|---|
| qNum | Maximum number of points that a cell can contain. | String |
| qElemNumber | Is set to 0. | Boolean |
| qState | The default value is L. | One of:
|
The next arrays give the coordinates of each cell in the page. Each array contains the following properties:
| Name | Description | Type |
|---|---|---|
| qText | Coordinates of a cell in the measure range. “qText”: “[[<left>, <top>, <right>, <bottom>], [<left>, <top>, <right>, <bottom>], .... [<left>, <top>, <right>, <bottom>]] Where: < left >, < top >, < right > and < bottom > are the coordinates of the cell in the measure range. |
String |
| qNum | Number of points in the cell. | Double precision floating point |
| qElemNumber | Unique identifier for each cell, calculated by the engine during the construction of the grid. This element number is not stored in the database and can have a positive or a negative value. |
Integer |
| qState | The default value is L. | One of:
|
Dimension values and measures values
More details about the properties, when dimension and measure values are returned, are given in this paragraph. When the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned. The first array is empty because no information on the adaptive grid is needed. The next arrays bring information about the dimension and the measure values.
| Name | Description | Type |
|---|---|---|
| qText | Text value of the dimension or the measure. | String |
| qNum | Numerical value of the dimension or the measure. Is set to 0 if the value is only text. |
Double precision floating point |
| qElemNumber | Unique identifier for each cell, calculated by the engine during the construction of the grid. This element number is not stored in the database and can have a positive or a negative value. |
Integer |
| qState | The default value is L. | One of:
|
Parameters
- qPathstringRequired
Path to the definition of the object. For example, /qHyperCubeDef .
- qPagesarray of objectsRequired
Array of pages to retrieve. Since the generic object contains two measures and one dimension, qWidth should be set to 3. If the value of a measure is Null, the value cannot be rendered. Therefore, the number of elements rendered in a page can be less than the number defined in the property qHeight .
qPages properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qViewportobjectRequired
Defines the canvas and the zoom level. This parameter is not yet used and is optional.
qViewport properties
- qWidthinteger
Width of the canvas in pixels.
- qHeightinteger
Height of the canvas in pixels.
- qZoomLevelinteger
Zoom level.
-
- qDataRangesarray of objectsRequired
Range of the data to render. This range applies to the measure values. The lowest and highest values of a measure can be retrieved by using the GetLayout method (in /qHyperCube/qMeasureInfo ).
qDataRanges properties
- qLeftnumber
Position from the left. Corresponds to the lowest possible value of the first measure (the measure on the x-axis).
- qTopnumber
Position from the top. Corresponds to the highest possible value of the second measure (the measure on the y-axis).
- qWidthnumber
Width of the page. Corresponds to the highest possible value of the first measure (the measure on the x-axis).
- qHeightnumber
Height of the page. The difference between qTop and qHeight gives the lowest possible value of the second measure (the measure on the y-axis).
-
- qMaxNbrCellsintegerRequired
Maximum number of cells in the grid.
- qQueryLevelintegerRequired
Level of details. The higher the level, the more detailed information you get (zoom-in). When the number of points to render falls below a certain threshold, the values are no longer rendered as cells but as points. The query level should be no greater than 20.
- qBinningMethodintegerRequired
Selects the algorithm. The default value is 0. One of:
- 0: Adaptive grid
- 1: Hexagonal grid
- 2: Uniform grid
Response
- qDataPagesarray of objects
qDataPages properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text. This parameter is optional.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qStatestring
Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"
- qIsEmptyboolean
Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .
- qIsTotalCellboolean
Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.
- qIsOtherCellboolean
Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.
- qFrequencystring
Frequency of the value. This parameter is optional.
- qHighlightRangesobject
qHighlightRanges properties
- qRangesarray of objects
Ranges of highlighted values.
qRanges properties
- qCharPosinteger
Position of the first search occurrence.
- qCharCountinteger
Number of occurrences found.
-
-
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
- qIsNullboolean
Is set to true if the value is Null.
- qMiniChartobject
qMiniChart properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
-
- qMinnumber
- qMaxnumber
- qErrorobject
qError properties
- qErrorCodeinteger
Error code. This parameter is always displayed in case of error.
- qContextstring
Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.
- qExtendedMessagestring
Internal information from the server. This parameter is optional.
-
-
- qInExtRowboolean
-
- qTailsarray of objects
Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .
qTails properties
- qUpinteger
Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.
- qDowninteger
Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.
-
- qAreaobject
qArea properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qIsReducedboolean
Is set to true, if the data have been reduced. The default value is false.
-
Errors
arrayGetHyperCubeBinnedData(qPath, qPages, qViewport, qDataRanges, qMaxNbrCells, qQueryLevel, qBinningMethod)
const result = await genericObject.GetHyperCubeBinnedData([
"value",
[
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
],
{
"qWidth": 123,
"qHeight": 123,
"qZoomLevel": 123
},
[
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
],
123,
123,
123
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetHyperCubeBinnedData",
"params": {
"qPath": "value",
"qPages": [
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
],
"qViewport": {
"qWidth": 123,
"qHeight": 123,
"qZoomLevel": 123
},
"qDataRanges": [
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
],
"qMaxNbrCells": 123,
"qQueryLevel": 123,
"qBinningMethod": 123
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qDataPages": [
{
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qState": "L",
"qIsEmpty": true,
"qIsTotalCell": true,
"qIsOtherCell": true,
"qFrequency": "value",
"qHighlightRanges": {
"qRanges": [
{
"qCharPos": 123,
"qCharCount": 123
}
]
},
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
},
"qIsNull": true,
"qMiniChart": {
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
}
}
]
],
"qMin": 123,
"qMax": 123,
"qError": {
"qErrorCode": 123,
"qContext": "value",
"qExtendedMessage": "value"
}
},
"qInExtRow": true
}
]
],
"qTails": [
{
"qUp": 123,
"qDown": 123
}
],
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
},
"qIsReduced": true
}
]
}
}
Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.
Parameters
- qPathstringRequired
Path to the definition of the object. For example, /qHyperCubeDef .
- qOptionsobjectRequired
Defines the data to return.
qOptions properties
- qStartnumber
Start value.
- qEndnumber
End value.
- qNbrPointsinteger
Number of bins for binning.
- qMaxNbrTicksinteger
Maximum number of ticks.
- qMaxNumberLinesinteger
Maximum number of lines.
-
- qReverseSortboolean
If set to true the returned data pages are reverse sorted. Optional.
Response
- qDataPagesarray of objects
qDataPages properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text. This parameter is optional.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qStatestring
Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"
- qIsEmptyboolean
Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .
- qIsTotalCellboolean
Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.
- qIsOtherCellboolean
Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.
- qFrequencystring
Frequency of the value. This parameter is optional.
- qHighlightRangesobject
qHighlightRanges properties
- qRangesarray of objects
Ranges of highlighted values.
qRanges properties
- qCharPosinteger
Position of the first search occurrence.
- qCharCountinteger
Number of occurrences found.
-
-
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
- qIsNullboolean
Is set to true if the value is Null.
- qMiniChartobject
qMiniChart properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
-
- qMinnumber
- qMaxnumber
- qErrorobject
qError properties
- qErrorCodeinteger
Error code. This parameter is always displayed in case of error.
- qContextstring
Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.
- qExtendedMessagestring
Internal information from the server. This parameter is optional.
-
-
- qInExtRowboolean
-
- qTailsarray of objects
Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .
qTails properties
- qUpinteger
Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.
- qDowninteger
Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.
-
- qAreaobject
qArea properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qIsReducedboolean
Is set to true, if the data have been reduced. The default value is false.
-
- qAxisDataobject
qAxisData properties
- qAxisarray of objects
List of axis data.
qAxis properties
- qNamestring
Name of the derived definition.
- qTagsarray of strings
List of tags.
- qTicksarray of objects
List of ticks.
qTicks properties
- qTextstring
Tick's label.
- qStartnumber
Start value.
- qEndnumber
End value.
-
-
-
Errors
arrayGetHyperCubeContinuousData(qPath, qOptions, qReverseSort?)
const result = await genericObject.GetHyperCubeContinuousData([
"value",
{
"qStart": 123,
"qEnd": 123,
"qNbrPoints": 123,
"qMaxNbrTicks": 123,
"qMaxNumberLines": -1
},
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetHyperCubeContinuousData",
"params": {
"qPath": "value",
"qOptions": {
"qStart": 123,
"qEnd": 123,
"qNbrPoints": 123,
"qMaxNbrTicks": 123,
"qMaxNumberLines": -1
},
"qReverseSort": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qDataPages": [
{
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qState": "L",
"qIsEmpty": true,
"qIsTotalCell": true,
"qIsOtherCell": true,
"qFrequency": "value",
"qHighlightRanges": {
"qRanges": [
{
"qCharPos": 123,
"qCharCount": 123
}
]
},
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
},
"qIsNull": true,
"qMiniChart": {
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
}
}
]
],
"qMin": 123,
"qMax": 123,
"qError": {
"qErrorCode": 123,
"qContext": "value",
"qExtendedMessage": "value"
}
},
"qInExtRow": true
}
]
],
"qTails": [
{
"qUp": 123,
"qDown": 123
}
],
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
},
"qIsReduced": true
}
],
"qAxisData": {
"qAxis": [
{
"qName": "value",
"qTags": [
"value"
],
"qTicks": [
{
"qText": "value",
"qStart": 123,
"qEnd": 123
}
]
}
]
}
}
}
Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.
Limitations on the number of cells
The maximum for the combined total number of cells across all pages is:
- 10,000 cells. If this limit is exceeded, a calc-pages-too-large error with code 7009 is returned.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qPagesarray of objectsRequired
Array of pages to retrieve.
qPages properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
Response
- qDataPagesarray of objects
qDataPages properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text. This parameter is optional.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qStatestring
Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"
- qIsEmptyboolean
Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .
- qIsTotalCellboolean
Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.
- qIsOtherCellboolean
Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.
- qFrequencystring
Frequency of the value. This parameter is optional.
- qHighlightRangesobject
qHighlightRanges properties
- qRangesarray of objects
Ranges of highlighted values.
qRanges properties
- qCharPosinteger
Position of the first search occurrence.
- qCharCountinteger
Number of occurrences found.
-
-
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
- qIsNullboolean
Is set to true if the value is Null.
- qMiniChartobject
qMiniChart properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
-
- qMinnumber
- qMaxnumber
- qErrorobject
qError properties
- qErrorCodeinteger
Error code. This parameter is always displayed in case of error.
- qContextstring
Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.
- qExtendedMessagestring
Internal information from the server. This parameter is optional.
-
-
- qInExtRowboolean
-
- qTailsarray of objects
Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .
qTails properties
- qUpinteger
Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.
- qDowninteger
Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.
-
- qAreaobject
qArea properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qIsReducedboolean
Is set to true, if the data have been reduced. The default value is false.
-
Errors
arrayGetHyperCubeData(qPath, qPages)
const result = await genericObject.GetHyperCubeData([
"value",
[
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
]
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetHyperCubeData",
"params": {
"qPath": "value",
"qPages": [
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
]
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qDataPages": [
{
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qState": "L",
"qIsEmpty": true,
"qIsTotalCell": true,
"qIsOtherCell": true,
"qFrequency": "value",
"qHighlightRanges": {
"qRanges": [
{
"qCharPos": 123,
"qCharCount": 123
}
]
},
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
},
"qIsNull": true,
"qMiniChart": {
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
}
}
]
],
"qMin": 123,
"qMax": 123,
"qError": {
"qErrorCode": 123,
"qContext": "value",
"qExtendedMessage": "value"
}
},
"qInExtRow": true
}
]
],
"qTails": [
{
"qUp": 123,
"qDown": 123
}
],
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
},
"qIsReduced": true
}
]
}
}
Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qPagesarray of objectsRequired
Array of pages to retrieve.
qPages properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
Response
- qDataPagesarray of objects
qDataPages properties
- qLeftarray of objects
Information about the left dimension values of a pivot table.
qLeft properties
- qTextstring
Some text.
- qElemNointeger
Rank number of the value. If set to -1, it means that the value is not an element number.
- qValuenumber
Value of the cell. Is set to NaN , if the value is not a number.
- qCanExpandboolean
If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.
- qCanCollapseboolean
If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.
- qTypestring
Can be one of: "V""E""N""T""O""A""P""R""U""G"
- qUpinteger
Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .
- qDowninteger
Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .
- qSubNodesarray of undefineds
Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
-
- qToparray of objects
Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.
qTop properties
- qTextstring
Some text.
- qElemNointeger
Rank number of the value. If set to -1, it means that the value is not an element number.
- qValuenumber
Value of the cell. Is set to NaN , if the value is not a number.
- qCanExpandboolean
If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.
- qCanCollapseboolean
If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.
- qTypestring
Can be one of: "V""E""N""T""O""A""P""R""U""G"
- qUpinteger
Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .
- qDowninteger
Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .
- qSubNodesarray of undefineds
Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
-
- qDataarray of arrays
Array of data.
qData properties
- qLabelstring
Label of the cell. This parameter is optional.
- qTextstring
Some text related to the cell.
- qNumnumber
Value of the cell.
- qTypestring
Can be one of: "V""E""N""T""O""A""P""R""U""G"
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
-
- qAreaobject
qArea properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
-
Errors
arrayGetHyperCubePivotData(qPath, qPages)
const result = await genericObject.GetHyperCubePivotData([
"value",
[
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
]
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetHyperCubePivotData",
"params": {
"qPath": "value",
"qPages": [
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
]
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qDataPages": [
{
"qLeft": [
{
"qText": "value",
"qElemNo": 123,
"qValue": 123,
"qCanExpand": true,
"qCanCollapse": true,
"qType": "V",
"qUp": 123,
"qDown": 123,
"qSubNodes": [],
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
}
}
],
"qTop": [
{
"qText": "value",
"qElemNo": 123,
"qValue": 123,
"qCanExpand": true,
"qCanCollapse": true,
"qType": "V",
"qUp": 123,
"qDown": 123,
"qSubNodes": [],
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
}
}
],
"qData": [
[
{
"qLabel": "value",
"qText": "value",
"qNum": 123,
"qType": "V",
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
}
}
]
],
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
}
]
}
}
Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them. The reduction is dependent on the zoom factor (parameter qZoomFactor ) and on the reduction mode.
Bar chart or line chart data reduction
For the data reduction to happen, the following conditions must be fulfilled:
- The values cannot fit in the defined page (parameter qPages ).
- The zoom factor is not 0 (parameter qZoomFactor ).
- The reduction mode must be set to D1.
The reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.
Example
If you have a chart with 1 million data, and you have set the zoom factor to 5, the GetHyperCubeReducedData method reduces the chart and retrieves 200 000 data.
Scatter plot chart data reduction
The reduction mode must be set to C. This reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid. The number of centroids can be defined in the parameter qZoomFactor.
Scatter plot chart resolution reduction
The reduction mode must be set to S. The resolution is reduced according to the zoom factor (parameter qZoomFactor ).
Example
If you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qPagesarray of objectsRequired
Array of pages.
qPages properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qZoomFactorintegerRequired
Defines the zoom factor. If set to -1, the engine decides of the zoom factor.
- If the reduction mode is D1 or S , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32.
- If the reduction mode is C , the zoom factor defines the number of centroids.
- qReductionModestringRequired
Defines the reduction mode.
One of:
- N or DATA_REDUCTION_NONE
- D1 or DATA_REDUCTION_ONEDIM
- S or DATA_REDUCTION_SCATTERED
- C or DATA_REDUCTION_CLUSTERED
- ST or DATA_REDUCTION_STACKED
Response
- qDataPagesarray of objects
qDataPages properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text. This parameter is optional.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qStatestring
Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"
- qIsEmptyboolean
Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .
- qIsTotalCellboolean
Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.
- qIsOtherCellboolean
Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.
- qFrequencystring
Frequency of the value. This parameter is optional.
- qHighlightRangesobject
qHighlightRanges properties
- qRangesarray of objects
Ranges of highlighted values.
qRanges properties
- qCharPosinteger
Position of the first search occurrence.
- qCharCountinteger
Number of occurrences found.
-
-
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
- qIsNullboolean
Is set to true if the value is Null.
- qMiniChartobject
qMiniChart properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
-
- qMinnumber
- qMaxnumber
- qErrorobject
qError properties
- qErrorCodeinteger
Error code. This parameter is always displayed in case of error.
- qContextstring
Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.
- qExtendedMessagestring
Internal information from the server. This parameter is optional.
-
-
- qInExtRowboolean
-
- qTailsarray of objects
Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .
qTails properties
- qUpinteger
Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.
- qDowninteger
Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.
-
- qAreaobject
qArea properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qIsReducedboolean
Is set to true, if the data have been reduced. The default value is false.
-
Errors
arrayGetHyperCubeReducedData(qPath, qPages, qZoomFactor, qReductionMode)
const result = await genericObject.GetHyperCubeReducedData([
"value",
[
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
],
123,
"value"
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetHyperCubeReducedData",
"params": {
"qPath": "value",
"qPages": [
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
],
"qZoomFactor": 123,
"qReductionMode": "value"
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qDataPages": [
{
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qState": "L",
"qIsEmpty": true,
"qIsTotalCell": true,
"qIsOtherCell": true,
"qFrequency": "value",
"qHighlightRanges": {
"qRanges": [
{
"qCharPos": 123,
"qCharCount": 123
}
]
},
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
},
"qIsNull": true,
"qMiniChart": {
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
}
}
]
],
"qMin": 123,
"qMax": 123,
"qError": {
"qErrorCode": 123,
"qContext": "value",
"qExtendedMessage": "value"
}
},
"qInExtRow": true
}
]
],
"qTails": [
{
"qUp": 123,
"qDown": 123
}
],
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
},
"qIsReduced": true
}
]
}
}
Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qPagesarray of objectsRequired
Array of pages to retrieve.
qPages properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qMaxNbrCellsinteger
Maximum number of cells at outer level. The default value is 10 000.
Response
- qDataPagesarray of objects
qDataPages properties
- qDataarray of objects
Array of data.
qData properties
- qTextstring
Some text.
- qElemNointeger
Rank number of the value. If set to -1, it means that the value is not an element number.
- qValuenumber
Value of the cell. Is set to NaN , if the value is not a number.
- qCanExpandboolean
If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.
- qCanCollapseboolean
If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.
- qTypestring
Can be one of: "V""E""N""T""O""A""P""R""U""G"
- qMaxPosnumber
Total of the positive values in the current group of cells.
- qMinNegnumber
Total of the negative values in the current group of cells.
- qUpinteger
Number of elements that are part of the previous tail.
- qDowninteger
Number of elements that are part of the next tail.
- qRowinteger
Row index in the data matrix. The indexing starts from 0.
- qSubNodesarray of undefineds
Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
-
- qAreaobject
qArea properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
-
Errors
arrayGetHyperCubeStackData(qPath, qPages, qMaxNbrCells?)
const result = await genericObject.GetHyperCubeStackData([
"value",
[
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
],
123
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetHyperCubeStackData",
"params": {
"qPath": "value",
"qPages": [
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
],
"qMaxNbrCells": 123
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qDataPages": [
{
"qData": [
{
"qText": "value",
"qElemNo": 123,
"qValue": 123,
"qCanExpand": true,
"qCanCollapse": true,
"qType": "V",
"qMaxPos": 123,
"qMinNeg": 123,
"qUp": 123,
"qDown": 123,
"qRow": 123,
"qSubNodes": [],
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
}
}
],
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
}
]
}
}
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected.
- qNodeOptionsobject
Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned.
qNodeOptions properties
- qMaxNbrOfNodesinteger
Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.
- qTreeNodesarray of objects
Defines areas of the tree to be fetched. Areas must be defined left to right.
qTreeNodes properties
- qAreaobject
qArea properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qAllValuesboolean
When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
-
- qTreeLevelsobject
qTreeLevels properties
- qLeftinteger
The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.
- qDepthinteger
Number of dimensions to include in the tree.
-
-
Response
- qNodesarray of objects
Represents a dimension in the tree.
qNodes properties
- qTextstring
The text version of the value, if available.
- qValuenumber
Value of the cell. Is set to NaN , if the value is not a number.
- qElemNointeger
Element number.
- qGroupPosinteger
The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.
- qGroupSizeinteger
Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.
- qRowinteger
Row index in the data matrix. The indexing starts from 0.
- qTypestring
Can be one of: "V""E""N""T""O""A""P""R""U""G"
- qValuesarray of objects
The measures for this node.
qValues properties
- qTextstring
The text version of the value, if available.
- qValuenumber
Value of the cell. Is set to NaN , if the value is not a number.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
-
- qNodesarray of undefineds
The children of this node in the fetched tree structure.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
- qMaxPosarray of numbers
Total of the positive values in the current group of cells.
- qMinNegarray of numbers
Total of the negative values in the current group of cells.
- qCanExpandboolean
If set to true, it means that the cell can be expanded. This parameter is not returned if it is set to false.
- qCanCollapseboolean
If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.
- qStatestring
Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"
- qTreePatharray of integers
The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.
-
Errors
arrayGetHyperCubeTreeData(qPath, qNodeOptions?)
const result = await genericObject.GetHyperCubeTreeData([
"value",
{
"qMaxNbrOfNodes": 123,
"qTreeNodes": [
{
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
},
"qAllValues": true
}
],
"qTreeLevels": {
"qLeft": 123,
"qDepth": -1
}
}
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetHyperCubeTreeData",
"params": {
"qPath": "value",
"qNodeOptions": {
"qMaxNbrOfNodes": 123,
"qTreeNodes": [
{
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
},
"qAllValues": true
}
],
"qTreeLevels": {
"qLeft": 123,
"qDepth": -1
}
}
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qNodes": [
{
"qText": "value",
"qValue": 123,
"qElemNo": 123,
"qGroupPos": 123,
"qGroupSize": 123,
"qRow": 123,
"qType": "V",
"qValues": [
{
"qText": "value",
"qValue": 123,
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
}
}
],
"qNodes": [],
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
},
"qMaxPos": [
123
],
"qMinNeg": [
123
],
"qCanExpand": true,
"qCanCollapse": true,
"qState": "L",
"qTreePath": [
123
]
}
]
}
}
Returns the type and identifier of the object.
Response
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
Errors
arrayGetInfo()
const result = await genericObject.GetInfo({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetInfo"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qInfo": {
"qId": "value",
"qType": "value"
}
}
}
Evaluates an object and displays its properties including the dynamic properties. If the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.
Example:
A is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E. A GetLayout call on A returns information on the objects A, B and C. A GetLayout call on B returns information on the objects B, D and E. A GetLayout call on C returns information on the object C.
Response
- qLayoutobject
Is the layout for GenericObjectProperties.
qLayout properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qMetaobject
Layout for NxMetaDef.
qMeta properties
- qNamestring
Name. This property is optional.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the object you want to link to. If you do not want to link your object, set this parameter to an empty string.
- qHasSoftPatchesboolean
Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied).
- qErrorobject
qError properties
- qErrorCodeinteger
Error code.
-
- qSelectionInfoobject
qSelectionInfo properties
- qInSelectionsboolean
Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections Method.
- qMadeSelectionsboolean
Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode. For more information about the selection mode, see BeginSelections Method.
-
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
Errors
arrayGetLayout()
const result = await genericObject.GetLayout({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetLayout"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qLayout": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qMeta": {
"qName": "value"
},
"qExtendsId": "value",
"qHasSoftPatches": true,
"qError": {
"qErrorCode": 123
},
"qSelectionInfo": {
"qInSelections": true,
"qMadeSelections": true
},
"qStateName": "value"
}
}
}
Lists the linked objects to a generic object, a dimension or a measure.
Response
- qItemsarray of objects
qItems properties
- qRootIdstring
Identifier of the root object. If the linked object is a child, the root identifier is the identifier of the parent. If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object.
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
-
Errors
arrayGetLinkedObjects()
const result = await genericObject.GetLinkedObjects({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetLinkedObjects"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qItems": [
{
"qRootId": "value",
"qInfo": {
"qId": "value",
"qType": "value"
}
}
]
}
}
Retrieves the values of a list object. A data set is returned.
Limitations on the number of cells
The maximum for the combined total number of cells across all pages is:
- 10,000 cells. If this limit is exceeded, a calc-pages-too-large error with code 7009 is returned.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qListObjectDef .
- qPagesarray of objectsRequired
Array of pages you are interested in.
qPages properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
Response
- qDataPagesarray of objects
qDataPages properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text. This parameter is optional.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qStatestring
Can be one of: "L""S""O""D""A""X""XS""XL""NSTATES"
- qIsEmptyboolean
Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .
- qIsTotalCellboolean
Is set to true if a total is displayed in the cell. This parameter is optional. The default value is false . Not applicable to list objects.
- qIsOtherCellboolean
Is set to true if the cell belongs to the group Others . Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp . This parameter is optional. The default value is false . Not applicable to list objects.
- qFrequencystring
Frequency of the value. This parameter is optional.
- qHighlightRangesobject
qHighlightRanges properties
- qRangesarray of objects
Ranges of highlighted values.
qRanges properties
- qCharPosinteger
Position of the first search occurrence.
- qCharCountinteger
Number of occurrences found.
-
-
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
- qAttrDimsobject
qAttrDims properties
- qValuesarray of objects
List of values.
qValues properties
- qTextstring
Text related to the attribute expression value. This property is optional. No text is returned if the attribute expression value is a numeric.
- qElemNointeger
Element number.
-
-
- qIsNullboolean
Is set to true if the value is Null.
- qMiniChartobject
qMiniChart properties
- qMatrixarray of arrays
Array of data.
qMatrix properties
- qTextstring
Some text.
- qNumnumber
A value. This parameter is optional.
- qElemNumberinteger
Rank number of the value, starting from 0. If the element number is a negative number, it means that the returned value is not an element number. You can get the following negative values:
- -1: the cell is a Total cell. It shows a total.
- -2: the cell is a Null cell.
- -3: the cell belongs to the group Others .
- -4: the cell is empty. Applies to pivot tables.
- qAttrExpsobject
qAttrExps properties
- qValuesarray of objects
List of attribute expressions values.
qValues properties
- qTextstring
Text related to the attribute expression value.
- qNumnumber
Numeric value of the attribute expression. Set to NaN (Not a Number) if the attribute expression value is not numeric.
-
-
-
- qMinnumber
- qMaxnumber
- qErrorobject
qError properties
- qErrorCodeinteger
Error code. This parameter is always displayed in case of error.
- qContextstring
Context related to the error, from the user app domain. It can be the identifier of an object, a field name, a table name. This parameter is optional.
- qExtendedMessagestring
Internal information from the server. This parameter is optional.
-
-
- qInExtRowboolean
-
- qTailsarray of objects
Array of tails. Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail. If there is no tail, the array is empty [ ] .
qTails properties
- qUpinteger
Number of elements that are part of the previous tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight . Is not shown if the value is 0. This parameter is optional.
- qDowninteger
Number of elements that are part of the next tail. This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight Is not shown if the value is 0. This parameter is optional.
-
- qAreaobject
qArea properties
- qLeftinteger
Position from the left. Corresponds to the first column.
- qTopinteger
Position from the top. Corresponds to the first row.
- qWidthinteger
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
- qHeightinteger
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
-
- qIsReducedboolean
Is set to true, if the data have been reduced. The default value is false.
-
Errors
arrayGetListObjectData(qPath, qPages)
const result = await genericObject.GetListObjectData([
"value",
[
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
]
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetListObjectData",
"params": {
"qPath": "value",
"qPages": [
{
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
}
]
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qDataPages": [
{
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qState": "L",
"qIsEmpty": true,
"qIsTotalCell": true,
"qIsOtherCell": true,
"qFrequency": "value",
"qHighlightRanges": {
"qRanges": [
{
"qCharPos": 123,
"qCharCount": 123
}
]
},
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
},
"qAttrDims": {
"qValues": [
{
"qText": "value",
"qElemNo": 123
}
]
},
"qIsNull": true,
"qMiniChart": {
"qMatrix": [
[
{
"qText": "value",
"qNum": 123,
"qElemNumber": 123,
"qAttrExps": {
"qValues": [
{
"qText": "value",
"qNum": 123
}
]
}
}
]
],
"qMin": 123,
"qMax": 123,
"qError": {
"qErrorCode": 123,
"qContext": "value",
"qExtendedMessage": "value"
}
},
"qInExtRow": true
}
]
],
"qTails": [
{
"qUp": 123,
"qDown": 123
}
],
"qArea": {
"qLeft": 123,
"qTop": 123,
"qWidth": 123,
"qHeight": 123
},
"qIsReduced": true
}
]
}
}
Returns the type of the object and the corresponding handle to the parent object in the hiearchy.
Response
- qReturnobject
qReturn properties
- qTypestring
The native type of the object.
- qHandleinteger
The handle used to connect to object.
- qGenericTypestring
The type of the object.
- qGenericIdstring
Object ID.
-
Errors
arrayGetParent()
const result = await genericObject.GetParent({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetParent"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qReturn": {
"qType": "value",
"qHandle": 123,
"qGenericType": "value",
"qGenericId": "value"
}
}
}
Returns the identifier, the type and the properties of the object. Because it is not mandatory to set all properties when you define an object, the GetProperties method may show properties that were not set. In that case, default values are given. If the object contains some soft properties, the soft properties are not returned by the GetProperties method. Use the GetEffectiveProperties method instead. If the object is linked to another object, the properties of the linking object are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.
Response
- qPropobject
qProp properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
Errors
arrayGetProperties()
const result = await genericObject.GetProperties({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetProperties"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qProp": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
}
}
Returns the type of the object and the corresponding handle.
Response
- qReturnobject
qReturn properties
- qTypestring
The native type of the object.
- qHandleinteger
The handle used to connect to object.
- qGenericTypestring
The type of the object.
- qGenericIdstring
Object ID.
-
Errors
arrayGetSnapshotObject()
const result = await genericObject.GetSnapshotObject({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "GetSnapshotObject"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qReturn": {
"qType": "value",
"qHandle": 123,
"qGenericType": "value",
"qGenericId": "value"
}
}
}
Locks the selected values of a generic object.
Parameters
- qPathstringRequired
Path to the definition of the object. For example, /qListObjectDef .
- qColIndicesarray of integers
Dimension numbers or dimension indexes where the lock should apply. Dimension numbers/indexes start from 0. If this parameter is not set, the selected values in all dimensions are locked.
Response
objectErrors
arrayLock(qPath, qColIndices?)
const result = await genericObject.Lock([
"value",
[
123
]
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "Lock",
"params": {
"qPath": "value",
"qColIndices": [
123
]
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Makes multiple range selections in measures.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qRangesarray of objectsRequired
Ranges of selections.
qRanges properties
- qRangesarray of objects
qRanges properties
- qRangeobject
qRange properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qMeasureIxinteger
Number of the measure to select. Numbering starts from 0.
-
- qColumnsToSelectarray of integers
-
- qOrModeboolean
Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false.
- qDeselectOnlyOneSelectedboolean
Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.
Response
- qSuccessboolean
Errors
arrayMultiRangeSelectHyperCubeValues(qPath, qRanges, qOrMode?, qDeselectOnlyOneSelected?)
const result = await genericObject.MultiRangeSelectHyperCubeValues([
"value",
[
{
"qRanges": [
{
"qRange": {
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
},
"qMeasureIx": 123
}
],
"qColumnsToSelect": [
123
]
}
],
true,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "MultiRangeSelectHyperCubeValues",
"params": {
"qPath": "value",
"qRanges": [
{
"qRanges": [
{
"qRange": {
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
},
"qMeasureIx": 123
}
],
"qColumnsToSelect": [
123
]
}
],
"qOrMode": true,
"qDeselectOnlyOneSelected": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Parameters
- qPathstringRequired
- qRangesarray of objectsRequired
qRanges properties
- qRangesarray of objects
An array of Ranges.
qRanges properties
- qRangeobject
qRange properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qMeasureIxinteger
Number of the measure to select. Numbering starts from 0.
- qDimensionIxinteger
Number of the dimension to select measure from. Numbering starts from 0.
-
-
- qOrModeboolean
- qDeselectOnlyOneSelectedboolean
Response
- qSuccessboolean
Errors
arrayMultiRangeSelectTreeDataValues(qPath, qRanges, qOrMode?, qDeselectOnlyOneSelected?)
const result = await genericObject.MultiRangeSelectTreeDataValues([
"value",
[
{
"qRanges": [
{
"qRange": {
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
},
"qMeasureIx": 123,
"qDimensionIx": 123
}
]
}
],
true,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "MultiRangeSelectTreeDataValues",
"params": {
"qPath": "value",
"qRanges": [
{
"qRanges": [
{
"qRange": {
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
},
"qMeasureIx": 123,
"qDimensionIx": 123
}
]
}
],
"qOrMode": true,
"qDeselectOnlyOneSelected": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Publishes a generic object.
Response
objectErrors
arrayPublish()
const result = await genericObject.Publish({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "Publish"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
GenericObject RangeSelectHyperCubeValues
(qPath, qRanges, qColumnsToSelect?, qOrMode?, qDeselectOnlyOneSelected?)Makes range selections in measures.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qRangesarray of objectsRequired
Ranges of selections.
qRanges properties
- qRangeobject
qRange properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qMeasureIxinteger
Number of the measure to select. Numbering starts from 0.
-
- qColumnsToSelectarray of integers
Indicates which dimensions to select. The dimensions numbering starts at 0 (first dimension is 0). If the array is empty, all dimensions are selected.
- qOrModeboolean
Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false.
- qDeselectOnlyOneSelectedboolean
Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.
Response
- qSuccessboolean
Errors
arrayRangeSelectHyperCubeValues(qPath, qRanges, qColumnsToSelect?, qOrMode?, qDeselectOnlyOneSelected?)
const result = await genericObject.RangeSelectHyperCubeValues([
"value",
[
{
"qRange": {
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
},
"qMeasureIx": 123
}
],
[
123
],
true,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "RangeSelectHyperCubeValues",
"params": {
"qPath": "value",
"qRanges": [
{
"qRange": {
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
},
"qMeasureIx": 123
}
],
"qColumnsToSelect": [
123
],
"qOrMode": true,
"qDeselectOnlyOneSelected": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
ResetMadeSelections()
const result = await genericObject.ResetMadeSelections({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "ResetMadeSelections"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Searches for a string in a list object.
Parameters
- qPathstringRequired
Path to the definition of the list object. For example, /qListObjectDef .
- qMatchstringRequired
Search string. Wild card characters are allowed. The search is not case sensitive. Examples:
P*U*: retrieves only values that start with P and contain UP U S: retrieves values that start with P, U or S
Response
- qSuccessboolean
Errors
arraySearchListObjectFor(qPath, qMatch)
const result = await genericObject.SearchListObjectFor([
"value",
"value"
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SearchListObjectFor",
"params": {
"qPath": "value",
"qMatch": "value"
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
GenericObject SelectHyperCubeCells
(qPath, qRowIndices, qColIndices, qSoftLock?, qDeselectOnlyOneSelected?)Makes selections in multiple dimensions and measures.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qRowIndicesarray of integersRequired
Array of row indexes to select, starting from 0. If the array is empty [ ] , all rows are selected.
- qColIndicesarray of integersRequired
Indexes of the columns to select, starting from 0. A column corresponds to a dimension in the order they are added to the hypercube. If a column is hidden it is ignored, qColIndex n refers to the n:th visible column (starting from zero). Example: If the hypercube has two dimensions:
- [0] selects the first column (i.e the first dimension).
- [1] selects the second column (i.e the second dimension).
If the array is empty [ ] , all columns are selected.
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected.
- qDeselectOnlyOneSelectedboolean
Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectHyperCubeCells(qPath, qRowIndices, qColIndices, qSoftLock?, qDeselectOnlyOneSelected?)
const result = await genericObject.SelectHyperCubeCells([
"value",
[
123
],
[
123
],
true,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectHyperCubeCells",
"params": {
"qPath": "value",
"qRowIndices": [
123
],
"qColIndices": [
123
],
"qSoftLock": true,
"qDeselectOnlyOneSelected": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
The following is returned in the output:
Parameters
- qPathstringRequired
Path to the definition of the object. For example, /qHyperCubeDef .
- qRangesarray of objectsRequired
Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals. If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to true then Min and Max values will be selected.
qRanges properties
- qRangeobject
qRange properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qDimIxinteger
Dimension index.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectHyperCubeContinuousRange(qPath, qRanges, qSoftLock?)
const result = await genericObject.SelectHyperCubeContinuousRange([
"value",
[
{
"qRange": {
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
},
"qDimIx": 123
}
],
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectHyperCubeContinuousRange",
"params": {
"qPath": "value",
"qRanges": [
{
"qRange": {
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
},
"qDimIx": 123
}
],
"qSoftLock": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Selects some values in one dimension. The values are identified by their element numbers.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qDimNointegerRequired
Dimension number or index to select. Dimension numbers/index start from 0.
- qValuesarray of integersRequired
Element numbers of the field to select. You can select multiple elements; the separator is the comma.
- qToggleModebooleanRequired
Set to true to toggle.
Response
- qSuccessboolean
Errors
arraySelectHyperCubeValues(qPath, qDimNo, qValues, qToggleMode)
const result = await genericObject.SelectHyperCubeValues([
"value",
123,
[
123
],
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectHyperCubeValues",
"params": {
"qPath": "value",
"qDimNo": 123,
"qValues": [
123
],
"qToggleMode": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Selects all values of a field.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qListObjectDef .
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectListObjectAll(qPath, qSoftLock?)
const result = await genericObject.SelectListObjectAll([
"value",
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectListObjectAll",
"params": {
"qPath": "value",
"qSoftLock": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Selects all alternative values in a specific field.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qListObjectDef .
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectListObjectAlternative(qPath, qSoftLock?)
const result = await genericObject.SelectListObjectAlternative([
"value",
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectListObjectAlternative",
"params": {
"qPath": "value",
"qSoftLock": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
The following is returned in the output:
Parameters
- qPathstringRequired
Path to the definition of the object. For example, /qHyperCubeDef .
- qRangesarray of objectsRequired
Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals. If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to true then Min and Max values will be selected.
qRanges properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectListObjectContinuousRange(qPath, qRanges, qSoftLock?)
const result = await genericObject.SelectListObjectContinuousRange([
"value",
[
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectListObjectContinuousRange",
"params": {
"qPath": "value",
"qRanges": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSoftLock": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Inverts the current selections in a specific field.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qListObjectDef .
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectListObjectExcluded(qPath, qSoftLock?)
const result = await genericObject.SelectListObjectExcluded([
"value",
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectListObjectExcluded",
"params": {
"qPath": "value",
"qSoftLock": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Selects all possible values of a list object.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qListObjectDef .
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectListObjectPossible(qPath, qSoftLock?)
const result = await genericObject.SelectListObjectPossible([
"value",
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectListObjectPossible",
"params": {
"qPath": "value",
"qSoftLock": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Makes single selections in dimensions.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qListObjectDef .
- qValuesarray of integersRequired
Element numbers to select. You can select multiple values; the separator is the comma.
- qToggleModebooleanRequired
Set to true to toggle.
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectListObjectValues(qPath, qValues, qToggleMode, qSoftLock?)
const result = await genericObject.SelectListObjectValues([
"value",
[
123
],
true,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectListObjectValues",
"params": {
"qPath": "value",
"qValues": [
123
],
"qToggleMode": true,
"qSoftLock": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
Pivot table
Makes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.
Stacked table
Makes selections in the left dimension cells of a stacked table or in the data matrix.
The member Change returns the handles of the objects that are updated following the selections. qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.
Parameters
- qPathstringRequired
Path to the definition of the object. For example, /qHyperCubeDef .
- qSelectionsarray of objectsRequired
Information about the selections to perform.
qSelections properties
- qTypestring
Can be one of: "D""T""L"
- qColinteger
Column index to select. Indexing starts from 0. If the cell's type is:
- D, the index is based on the data matrix.
- T, the index is based on the data matrix.
- L, the index is based on the left dimensions indexes.
- qRowinteger
Row index to select. Indexing starts from 0. If the cell's type is:
- D, the index is based on the data matrix.
- T, the index is based on the top dimensions indexes.
- L, the index is based on the data matrix.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected.
- qDeselectOnlyOneSelectedboolean
Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.
Response
- qSuccessboolean
Errors
arraySelectPivotCells(qPath, qSelections, qSoftLock?, qDeselectOnlyOneSelected?)
const result = await genericObject.SelectPivotCells([
"value",
[
{
"qType": "D",
"qCol": 123,
"qRow": 123
}
],
true,
true
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SelectPivotCells",
"params": {
"qPath": "value",
"qSelections": [
{
"qType": "D",
"qCol": 123,
"qRow": 123
}
],
"qSoftLock": true,
"qDeselectOnlyOneSelected": true
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"qSuccess": true
}
}
You can use the SetActiveField method with any object that contains a cyclic group as a dimension. This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken. A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qDimNointegerRequired
Dimension number or index starting from 0. The default value is 0.
- qNewIndexintegerRequired
Index of the field to jump to.
Response
objectErrors
arraySetActiveField(qPath, qDimNo, qNewIndex)
const result = await genericObject.SetActiveField([
"value",
123,
123
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SetActiveField",
"params": {
"qPath": "value",
"qDimNo": 123,
"qNewIndex": 123
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Sets the order of the children in a generic object.
Parameters
- qIdsarray of stringsRequired
List of the children identifiers.
Response
objectErrors
arraySetChildArrayOrder(qIds)
const result = await genericObject.SetChildArrayOrder([
[
"value"
]
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SetChildArrayOrder",
"params": {
"qIds": [
"value"
]
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Sets the properties of:
- A generic object.
- The children of the generic object.
- The bookmarks/embedded snapshots of the generic object.
Parameters
- qPropEntryobjectRequired
Information about the generic object entry.
qPropEntry properties
- qPropertyobject
qProperty properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
- qChildrenarray of undefineds
Information about the children of the generic object.
- qEmbeddedSnapshotRefobject
qEmbeddedSnapshotRef properties
- qPropertiesobject
qProperties properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qIncludeVariablesbooleanExperimental
If true all variables will be stored in the bookmark.
- qDistinctValuesbooleanExperimental
If true all selected values will be stored distinct, i.e. searchstrings will not be kept.
-
- qBookmarkobject
qBookmark properties
- qStateDataarray of objects
List of selections for each state.
qStateData properties
- qStateNamestring
Name of the alternate state. Default is current selections: $
- qFieldItemsarray of objects
List of the selections.
qFieldItems properties
- qDefobject
qDef properties
- qNamestring
Name of the field.
- qTypestring
Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"
-
- qLockedboolean
Indicates if the field is locked. Default is false.
- qSelectInfoobject
qSelectInfo properties
- qTextSearchstring
Text search string. Everything that matches the text is selected. This parameter is optional.
- qRangeLonumber
Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qRangeHinumber
Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qNumberFormatobject
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberFormat properties
- qTypestring
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDecinteger
Number of decimals. Default is 10.
- qUseThouinteger
Defines whether or not a thousands separator must be used. Default is 0.
- qFmtstring
Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
- qDecstring
Defines the decimal separator. Example: .
- qThoustring
Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
- qRangeInfoarray of objects
This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.
qRangeInfo properties
- qRangeLonumber
Lowest value in the range.
- qRangeHinumber
Highest value in the range.
- qMeasurestring
Label of the measure.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
- qContinuousRangeInfoarray of objects
List of information about ranges for selections.
qContinuousRangeInfo properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qSelectFieldSearchboolean
This parameter is true if the TextSearch is a result of a Select Field operation.
-
- qValuesarray of objects
qValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qExcludedValuesarray of objects
List of excluded values. Either the list of selected values or the list of excluded values is displayed.
qExcludedValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qAndModeboolean
If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.
- qOneAndOnlyOneboolean
If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.
-
-
- qUtcModifyTimenumber
Time when the bookmark was created.
- qVariableItemsarray of objects
List of the variables in the app at the time the bookmark was created.
qVariableItems properties
- qNamestring
Name of the variable.
- qValueobject
qValue properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qDefinitionstring
The Reporting mode definition of the variable.
-
- qPatchesarray of objects
Softpatches to be applied with this bookmark.
qPatches properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qPatchesarray of objects
Array with patches.
qPatches properties
- qOpstring
Can be one of: "add""remove""replace"
- qPathstring
Path to the property to add, remove or replace.
- qValuestring
This parameter is not used in a remove operation. Corresponds to the value of the property to add or to the new value of the property to update. Examples: "false", "2", ""New title""
-
- qChildrenarray of undefineds
Array with child objects and their patches.
-
- qCyclicGroupStatesarray of objects
Information about cyclic groups by zero-based index. This field is unused.
qCyclicGroupStates properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qActiveFieldinteger
Active field of the cyclic group, identified by a zero-based index.
-
- qGroupStatesarray of objectsExperimental
Information about cyclic groups indexed by field definition.
qGroupStates properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qActiveFieldDefstring
String defining the active field.
-
-
- qClassicBookmarkobject
qClassicBookmark properties
- qIdstring
- qNamestring
- qUtcModifyTimenumber
- qUtcRecallTimenumber
- qRecallCountinteger
- qApplyAdditiveboolean
- qFieldItemsarray of objects
qFieldItems properties
- qDefobject
qDef properties
- qNamestring
Name of the field.
- qTypestring
Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"
-
- qLockedboolean
Indicates if the field is locked. Default is false.
- qSelectInfoobject
qSelectInfo properties
- qTextSearchstring
Text search string. Everything that matches the text is selected. This parameter is optional.
- qRangeLonumber
Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qRangeHinumber
Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qNumberFormatobject
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberFormat properties
- qTypestring
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDecinteger
Number of decimals. Default is 10.
- qUseThouinteger
Defines whether or not a thousands separator must be used. Default is 0.
- qFmtstring
Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
- qDecstring
Defines the decimal separator. Example: .
- qThoustring
Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
- qRangeInfoarray of objects
This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.
qRangeInfo properties
- qRangeLonumber
Lowest value in the range.
- qRangeHinumber
Highest value in the range.
- qMeasurestring
Label of the measure.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
- qContinuousRangeInfoarray of objects
List of information about ranges for selections.
qContinuousRangeInfo properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qSelectFieldSearchboolean
This parameter is true if the TextSearch is a result of a Select Field operation.
-
- qValuesarray of objects
qValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qExcludedValuesarray of objects
List of excluded values. Either the list of selected values or the list of excluded values is displayed.
qExcludedValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qAndModeboolean
If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.
- qOneAndOnlyOneboolean
If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.
-
- qVariableItemsarray of objects
qVariableItems properties
- qNamestring
Name of the variable.
- qValueobject
qValue properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qDefinitionstring
The Reporting mode definition of the variable.
-
- qSheetIdstring
- qObjectsarray of objects
qObjects properties
- qIdstring
- qActiveboolean
- qShowModeinteger
- qScrollPosobject
qScrollPos properties
- qUsePositionboolean
- qPosobject
qPos properties
- qxinteger
x-coordinate in pixels. The origin is the top left of the screen.
- qyinteger
y-coordinate in pixels. The origin is the top left of the screen.
-
-
-
- qApplyLayoutStateboolean
- qShowPopupInfoboolean
- qInfoTextstring
- qOwnerstring
- qGroupsarray of objects
qGroups properties
- qIdstring
- qCyclePosinteger
-
- qShowobject
qShow properties
- qAlwaysboolean
- qExpressionobject
qExpression properties
- qvstring
Expression evaluated to dual.
-
-
- qApplyInputFieldValuesboolean
- qInputFieldItemsarray of objects
qInputFieldItems properties
- qFieldNamestring
- qValuesarray of objects
qValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qPackedHashKeysarray of integers
-
- qObjectsLayoutarray of objects
qObjectsLayout properties
- qIdstring
- qActiveboolean
- qShowModeinteger
- qScrollPosobject
qScrollPos properties
- qUsePositionboolean
- qPosobject
qPos properties
- qxinteger
x-coordinate in pixels. The origin is the top left of the screen.
- qyinteger
y-coordinate in pixels. The origin is the top left of the screen.
-
-
- qExpansionInfoarray of objects
qExpansionInfo properties
- qExcludeListboolean
- qPosobject
qPos properties
- qDimNamestring
- qElemNoarray of integers
- qElemValuesarray of strings
-
-
- qLeftCollapsedboolean
- qTopCollapsedboolean
- qSortDataarray of objects
qSortData properties
- qNamestring
- qReversedboolean
-
- qDimensionGroupPosarray of objects
qDimensionGroupPos properties
- qGroupNamestring
- qCurrentItemNamestring
-
- qExpressionGroupPosarray of objects
qExpressionGroupPos properties
- qGroupNamestring
- qCurrentItemNamestring
-
- qUseGraphModeboolean
- qGraphModestring
Can be one of: "GRAPH_MODE_BAR""GRAPH_MODE_PIE""GRAPH_MODE_PIVOTTABLE""GRAPH_MODE_SCATTER""GRAPH_MODE_LINE""GRAPH_MODE_STRAIGHTTABLE""GRAPH_MODE_COMBO""GRAPH_MODE_RADAR""GRAPH_MODE_GAUGE""GRAPH_MODE_GRID""GRAPH_MODE_BLOCK""GRAPH_MODE_FUNNEL""GRAPH_MODE_MEKKO""GRAPH_MODE_LAST"
- qActiveContainerChildObjectIdstring
- qExtendedPivotStateobject
qExtendedPivotState properties
- qExpressionPositioninteger
- qNumberOfLeftDimensionsinteger
- qDimensionNamesarray of strings
- qEnableConditionsarray of strings
-
-
- qIncludeSelectionStateboolean
- qIncludeScrollPositionboolean
- qAlternateStateDataarray of objects
qAlternateStateData properties
- qStateNamestring
Name of the alternate state. Default is current selections: $
- qFieldItemsarray of objects
List of the selections.
qFieldItems properties
- qDefobject
qDef properties
- qNamestring
Name of the field.
- qTypestring
Can be one of: "NOT_PRESENT""PRESENT""IS_CYCLIC_GROUP""IS_DRILL_GROUP""IS_VAR""IS_EXPR""IS_IMPLICIT""IS_DETAIL"
-
- qLockedboolean
Indicates if the field is locked. Default is false.
- qSelectInfoobject
qSelectInfo properties
- qTextSearchstring
Text search string. Everything that matches the text is selected. This parameter is optional.
- qRangeLonumber
Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qRangeHinumber
Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
- qNumberFormatobject
Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
qNumberFormat properties
- qTypestring
Can be one of: "U""A""I""R""F""M""D""T""TS""IV"
- qnDecinteger
Number of decimals. Default is 10.
- qUseThouinteger
Defines whether or not a thousands separator must be used. Default is 0.
- qFmtstring
Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.
- qDecstring
Defines the decimal separator. Example: .
- qThoustring
Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,
- qRangeInfoarray of objects
This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.
qRangeInfo properties
- qRangeLonumber
Lowest value in the range.
- qRangeHinumber
Highest value in the range.
- qMeasurestring
Label of the measure.
-
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
- qContinuousRangeInfoarray of objects
List of information about ranges for selections.
qContinuousRangeInfo properties
- qMinnumber
Lowest value in the range
- qMaxnumber
Highest value in the range
- qMinInclEqboolean
If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
- qMaxInclEqboolean
If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)] Example: The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.
-
- qSelectFieldSearchboolean
This parameter is true if the TextSearch is a result of a Select Field operation.
-
- qValuesarray of objects
qValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qExcludedValuesarray of objects
List of excluded values. Either the list of selected values or the list of excluded values is displayed.
qExcludedValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qAndModeboolean
If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected. The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected. This parameter is not returned if set to false.
- qOneAndOnlyOneboolean
If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false.
-
-
- qForAnnotationsboolean
- qIncludeAllVariablesboolean
-
- qClassicMetadataobject
qClassicMetadata properties
- qSharedboolean
- qUtcModifyTimenumber
- qSheetIdstring
- qTemporaryboolean
- qRestrictedAccessboolean
- qAccessListarray of strings
- qPersonalEditionHash_OBSOLETEstring
- qHiddenboolean
- qLinkedToarray of strings
-
-
-
Response
objectErrors
arraySetFullPropertyTree(qPropEntry)
const result = await genericObject.SetFullPropertyTree([
{
"qProperty": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
},
"qChildren": [],
"qEmbeddedSnapshotRef": {
"qProperties": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qMetaDef": {},
"qIncludeVariables": true,
"qDistinctValues": true
},
"qBookmark": {
"qStateData": [
{
"qStateName": "value",
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
]
}
],
"qUtcModifyTime": 123,
"qVariableItems": [
{
"qName": "value",
"qValue": {
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
},
"qDefinition": "value"
}
],
"qPatches": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qPatches": [
{
"qOp": "add",
"qPath": "value",
"qValue": "value"
}
],
"qChildren": []
}
],
"qCyclicGroupStates": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qActiveField": 123
}
],
"qGroupStates": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qActiveFieldDef": "value"
}
]
},
"qClassicBookmark": {
"qId": "value",
"qName": "value",
"qUtcModifyTime": 123,
"qUtcRecallTime": 123,
"qRecallCount": 123,
"qApplyAdditive": true,
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
],
"qVariableItems": [
{
"qName": "value",
"qValue": {
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
},
"qDefinition": "value"
}
],
"qSheetId": "value",
"qObjects": [
{
"qId": "value",
"qActive": true,
"qShowMode": 123,
"qScrollPos": {
"qUsePosition": true,
"qPos": {
"qx": 123,
"qy": 123
}
}
}
],
"qApplyLayoutState": true,
"qShowPopupInfo": true,
"qInfoText": "value",
"qOwner": "value",
"qGroups": [
{
"qId": "value",
"qCyclePos": 123
}
],
"qShow": {
"qAlways": true,
"qExpression": {
"qv": "value"
}
},
"qApplyInputFieldValues": true,
"qInputFieldItems": [
{
"qFieldName": "value",
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qPackedHashKeys": [
123
]
}
],
"qObjectsLayout": [
{
"qId": "value",
"qActive": true,
"qShowMode": 123,
"qScrollPos": {
"qUsePosition": true,
"qPos": {
"qx": 123,
"qy": 123
}
},
"qExpansionInfo": [
{
"qExcludeList": true,
"qPos": {
"qDimName": "value",
"qElemNo": [
123
],
"qElemValues": [
"value"
]
}
}
],
"qLeftCollapsed": true,
"qTopCollapsed": true,
"qSortData": [
{
"qName": "value",
"qReversed": true
}
],
"qDimensionGroupPos": [
{
"qGroupName": "value",
"qCurrentItemName": "value"
}
],
"qExpressionGroupPos": [
{
"qGroupName": "value",
"qCurrentItemName": "value"
}
],
"qUseGraphMode": true,
"qGraphMode": "GRAPH_MODE_BAR",
"qActiveContainerChildObjectId": "value",
"qExtendedPivotState": {
"qExpressionPosition": 123,
"qNumberOfLeftDimensions": 123,
"qDimensionNames": [
"value"
],
"qEnableConditions": [
"value"
]
}
}
],
"qIncludeSelectionState": true,
"qIncludeScrollPosition": true,
"qAlternateStateData": [
{
"qStateName": "value",
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
]
}
],
"qForAnnotations": true,
"qIncludeAllVariables": true
},
"qClassicMetadata": {
"qShared": true,
"qUtcModifyTime": 123,
"qSheetId": "value",
"qTemporary": true,
"qRestrictedAccess": true,
"qAccessList": [
"value"
],
"qPersonalEditionHash_OBSOLETE": "value",
"qHidden": true,
"qLinkedTo": [
"value"
]
}
}
}
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SetFullPropertyTree",
"params": {
"qPropEntry": {
"qProperty": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
},
"qChildren": [],
"qEmbeddedSnapshotRef": {
"qProperties": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qMetaDef": {},
"qIncludeVariables": true,
"qDistinctValues": true
},
"qBookmark": {
"qStateData": [
{
"qStateName": "value",
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
]
}
],
"qUtcModifyTime": 123,
"qVariableItems": [
{
"qName": "value",
"qValue": {
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
},
"qDefinition": "value"
}
],
"qPatches": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qPatches": [
{
"qOp": "add",
"qPath": "value",
"qValue": "value"
}
],
"qChildren": []
}
],
"qCyclicGroupStates": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qActiveField": 123
}
],
"qGroupStates": [
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qActiveFieldDef": "value"
}
]
},
"qClassicBookmark": {
"qId": "value",
"qName": "value",
"qUtcModifyTime": 123,
"qUtcRecallTime": 123,
"qRecallCount": 123,
"qApplyAdditive": true,
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
],
"qVariableItems": [
{
"qName": "value",
"qValue": {
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
},
"qDefinition": "value"
}
],
"qSheetId": "value",
"qObjects": [
{
"qId": "value",
"qActive": true,
"qShowMode": 123,
"qScrollPos": {
"qUsePosition": true,
"qPos": {
"qx": 123,
"qy": 123
}
}
}
],
"qApplyLayoutState": true,
"qShowPopupInfo": true,
"qInfoText": "value",
"qOwner": "value",
"qGroups": [
{
"qId": "value",
"qCyclePos": 123
}
],
"qShow": {
"qAlways": true,
"qExpression": {
"qv": "value"
}
},
"qApplyInputFieldValues": true,
"qInputFieldItems": [
{
"qFieldName": "value",
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qPackedHashKeys": [
123
]
}
],
"qObjectsLayout": [
{
"qId": "value",
"qActive": true,
"qShowMode": 123,
"qScrollPos": {
"qUsePosition": true,
"qPos": {
"qx": 123,
"qy": 123
}
},
"qExpansionInfo": [
{
"qExcludeList": true,
"qPos": {
"qDimName": "value",
"qElemNo": [
123
],
"qElemValues": [
"value"
]
}
}
],
"qLeftCollapsed": true,
"qTopCollapsed": true,
"qSortData": [
{
"qName": "value",
"qReversed": true
}
],
"qDimensionGroupPos": [
{
"qGroupName": "value",
"qCurrentItemName": "value"
}
],
"qExpressionGroupPos": [
{
"qGroupName": "value",
"qCurrentItemName": "value"
}
],
"qUseGraphMode": true,
"qGraphMode": "GRAPH_MODE_BAR",
"qActiveContainerChildObjectId": "value",
"qExtendedPivotState": {
"qExpressionPosition": 123,
"qNumberOfLeftDimensions": 123,
"qDimensionNames": [
"value"
],
"qEnableConditions": [
"value"
]
}
}
],
"qIncludeSelectionState": true,
"qIncludeScrollPosition": true,
"qAlternateStateData": [
{
"qStateName": "value",
"qFieldItems": [
{
"qDef": {
"qName": "value",
"qType": "NOT_PRESENT"
},
"qLocked": true,
"qSelectInfo": {
"qTextSearch": "value",
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qNumberFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 123,
"qFmt": "value",
"qDec": "value",
"qThou": "value"
},
"qRangeInfo": [
{
"qRangeLo": -1e+300,
"qRangeHi": -1e+300,
"qMeasure": "value"
}
],
"qSoftLock": true,
"qContinuousRangeInfo": [
{
"qMin": 123,
"qMax": 123,
"qMinInclEq": true,
"qMaxInclEq": true
}
],
"qSelectFieldSearch": true
},
"qValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qExcludedValues": [
{
"qText": "value",
"qIsNumeric": true,
"qNumber": 123
}
],
"qAndMode": true,
"qOneAndOnlyOne": true
}
]
}
],
"qForAnnotations": true,
"qIncludeAllVariables": true
},
"qClassicMetadata": {
"qShared": true,
"qUtcModifyTime": 123,
"qSheetId": "value",
"qTemporary": true,
"qRestrictedAccess": true,
"qAccessList": [
"value"
],
"qPersonalEditionHash_OBSOLETE": "value",
"qHidden": true,
"qLinkedTo": [
"value"
]
}
}
}
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Sets some properties for a generic object.
Parameters
- qPropobjectRequired
Information about the generic object.
qProp properties
- qInfoobject
qInfo properties
- qIdstring
Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional.
- qTypestring
Type of the object. This parameter is mandatory.
-
- qExtendsIdstring
Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
- qMetaDefobject
Used to collect meta data.
Properties
Semantic type with an empty structure.
- qStateNamestring
Name of the alternate state. Default is current selections $ .
-
Response
objectErrors
arraySetProperties(qProp)
const result = await genericObject.SetProperties([
{
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "SetProperties",
"params": {
"qProp": {
"qInfo": {
"qId": "value",
"qType": "value"
},
"qExtendsId": "value",
"qMetaDef": {},
"qStateName": "value"
}
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
You can use the StepCycle method with any object that contains a cyclic group as a dimension. This method allows you to move between different fields in a cyclic dimension. A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed.
Parameters
- qPathstringRequired
Path to the definition of the object to be selected. For example, /qHyperCubeDef .
- qDimNointegerRequired
Dimension number or index starting from 0. The default value is 0.
- qNbrStepsintegerRequired
Number of steps you want to cycle. Positive values cycle forwards while negative values cycle backwards. A value of 0 leads to no action being taken.
Response
objectErrors
arrayStepCycle(qPath, qDimNo, qNbrSteps)
const result = await genericObject.StepCycle([
"value",
123,
123
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "StepCycle",
"params": {
"qPath": "value",
"qDimNo": 123,
"qNbrSteps": 123
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Removes the generic object from the list of approved objects
Response
objectErrors
arrayUnApprove()
const result = await genericObject.UnApprove({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "UnApprove"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Unpublishes a generic object.
Response
objectErrors
arrayUnPublish()
const result = await genericObject.UnPublish({})
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "UnPublish"
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}
Unlocks the selected values of a generic object if the target (or handle ) is a generic object
Parameters
- qPathstringRequired
Path to the definition of the object. For example, /qListObjectDef .
- qColIndicesarray of integers
Dimension numbers/indexes where the unlock should apply. Dimension numbers/indexes start from 0. If this parameter is not set, the locked values in all dimensions are unlocked.
Response
objectErrors
arrayUnlock(qPath, qColIndices?)
const result = await genericObject.Unlock([
"value",
[
123
]
])
Request
{
"jsonrpc": "2.0",
"id": 1,
"handle": 3,
"method": "Unlock",
"params": {
"qPath": "value",
"qColIndices": [
123
]
}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": {}
}