Skip to main content Skip to complementary content

SelectHyperCubeCells method

Makes selections in multiple dimensions and measures.

Information note

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 Integer
qColIndices

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.

Yes Array of Integer
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

See also

Select a set of cells in a hypercube

Did this page help you?

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!