Overview
Selects some values in one dimension.
The values are identified by their element numbers.
Information noteThis method applies to charts, tables and scatter plots.
Parameters
| Name | Description | Type |
|---|---|---|
| qPath |
Path to the definition of the object to be selected. For example, /qHyperCubeDef. This parameter is mandatory. |
String |
| qDimNo |
Dimension number or index to select. Dimension numbers/index start from 0. This parameter is mandatory. |
Integer |
| qValues |
Element numbers of the field to select. You can select multiple elements; the separator is the comma. This parameter is mandatory. |
Array of Integer |
| qToggleMode |
Set to true to toggle. This parameter is mandatory. |
Boolean True/False |
Outputs
The following is returned in the output:
{
"jsonrpc": "2.0",
"id": <identifier of the request>,
"result": {
"qSuccess": true/false
},
"change": [
<handle x>,
<handle y>
]
}
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.