SelectPivotCells Method
Overloads
| SelectPivotCells(String, IEnumerable<NxSelectionCell>, Boolean, Boolean) |
Pivot tableMakes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected. Stacked tableMakes selections in the left dimension cells of a stacked table or in the data matrix. Example of a pivot tablePlease refer to Engine API reference for illustrations. In the representation above: Please refer to Engine API reference for table definition. The member Change returns the handles of the objects that are updated following the selections.
* 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 |
SelectPivotCells(String, IEnumerable<NxSelectionCell>, Boolean, Boolean)
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
Please refer to Engine API reference for illustrations.
In the representation above:
Please refer to Engine API reference for table definition.
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.
Declaration
bool SelectPivotCells([QixName("qPath")] string path, [QixName("qSelections")] IEnumerable<NxSelectionCell> selections, [QixName("qSoftLock")] bool softLock = false, [QixName("qDeselectOnlyOneSelected")] bool deselectOnlyOneSelected = false)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path |
Path to the definition of the object.
For example, |
| System.Collections.Generic.IEnumerable<NxSelectionCell> | selections |
Information about the selections to perform. |
| System.Boolean | softLock |
Set to true to ignore locks; in that case, locked fields can be selected. |
| System.Boolean | deselectOnlyOneSelected |
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. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
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 .
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!