SelectHyperCubeCells method

Overview

Makes selections in multiple dimensions and measures.

This method applies to hypercubes, such as bar charts, tables and scatter plots.

Name	Description	Type
qPath	Path to the definition of the object to be selected. For example, /qHyperCubeDef. This parameter is mandatory.	String
qRowIndices	Array of row indexes to select, starting from 0. If the array is empty [ ], all rows are selected. This parameter is mandatory.	Array of Integer
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: [0] selects the first column (i.e the first dimension) [1] selects the second column (i.e the second dimension) [2] selects the third column (i.e the measure) If the array is empty [ ], all columns are selected. This parameter is mandatory.	Array of Integer
qSoftLock	Set to true to ignore locks; in that case, locked fields can be selected. This parameter is mandatory.	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.	Boolean

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.

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!