SelectPivotCells method

Overview

This 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.

There 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

Name	Description	Type
qType	Type of cells to select	One of: D for data T for top dimension cells L for left dimension cells
qCol	Column index to select Indexing starts from 0. If the cell's type is: D, the index is based on the data matrix. T, the index is based on the data matrix L, the index is based on the left dimensions indexes	Integer
qRow	Row index to select Indexing starts from 0. If the cell's type is: D, the index is based on the data matrix. T, the index is based on the top dimensions indexes L, the index is based on the data matrix	Integer

Name

Description

Type

qType

Type of cells to select

One of:

D for data
T for top dimension cells
L for left dimension cells

qCol

Column index to select

Indexing starts from 0.

If the cell's type is:

D, the index is based on the data matrix.
T, the index is based on the data matrix
L, the index is based on the left dimensions indexes

Integer

qRow

Row index to select

Indexing starts from 0.

If the cell's type is:

D, the index is based on the data matrix.
T, the index is based on the top dimensions indexes
L, the index is based on the data matrix

Integer

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.

Learn more

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!

Leave your feedback here