Skip to main content Skip to complementary content

SelectPivotCells method

Overview

Information noteThis method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P or K.

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.

Information noteThere is no top dimensions in a stacked table.

Example of a pivot table

In the representation above:

Sum(OrderTotal)

Count(OrderTotal)

Are pseudo dimensions.

CategoryName

Is a left dimension.

Beverages, Condiments... are left dimension values.

ProductName

Is a top dimension.

Chef Anton's Cajun Seasoning is a top dimension value.

Numeric values

Are calculated values in the data matrix.

626291,832 is a calculated value.

Parameters

Name Description Type
qPath

Path to the definition of the object

For example, /qHyperCubeDef.

This parameter is mandatory.

String
qSelections Information about the selections to perform Array of NxSelectionCell
qSoftLock Set to true to ignore locks; in that case, locked fields can be selected. This parameter is optional. 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

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.

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!