SelectPivotCells method
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.
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. |
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. For example, /qHyperCubeDef . |
Yes | String |
qSelections | Information about the selections to perform. |
Yes | Array of NxSelectionCell |
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 |