SelectHyperCubeCells method
Makes selections in multiple dimensions and measures.
This method applies to hypercubes, such as bar charts, tables and scatter plots.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.
Parameters
Name | Description | Mandatory | Type |
---|---|---|---|
qPath | Path to the definition of the object to be selected. For example, /qHyperCubeDef . |
Yes | String |
qRowIndices | Array of row indexes to select, starting from 0. If the array is empty [ ] , all rows are selected. |
Yes | Array of Integers |
qColIndices | Indexes of the columns to select, starting from 0. A column corresponds to a dimension or a measure depending on the definition of the hypercube. Example: If the hypercube has two dimensions and one measure:
If the array is empty [ ] , all columns are selected. |
Yes | Array of Integers |
qSoftLock | Set to true to ignore locks; in that case, locked fields can be selected. |
No | Boolean |
qDeselectOnlyOneSelected | 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. |
No | Boolean |
Returns
Name | Description | Type |
---|---|---|
qSuccess | true/false |
Boolean |