SelectHyperCubeCellsAsync Method
Overloads
| SelectHyperCubeCellsAsync(String, IEnumerable<Int32>, IEnumerable<Int32>, Boolean, Boolean) |
Makes selections in multiple dimensions and measures. 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 |
|
| SelectHyperCubeCellsAsync(AsyncHandle, String, IEnumerable<Int32>, IEnumerable<Int32>, Boolean, Boolean) |
Makes selections in multiple dimensions and measures. 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 |
|
| SelectHyperCubeCellsAsync<T>(AsyncHandle, Func<Response, T>, String, IEnumerable<Int32>, IEnumerable<Int32>, Boolean, Boolean) |
Makes selections in multiple dimensions and measures. 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 |
SelectHyperCubeCellsAsync(String, IEnumerable<Int32>, IEnumerable<Int32>, Boolean, Boolean)
Makes selections in multiple dimensions and measures.
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
Task<bool> SelectHyperCubeCellsAsync([QixName("qPath")] string path, [QixName("qRowIndices")] IEnumerable<int> rowIndices, [QixName("qColIndices")] IEnumerable<int> colIndices, [QixName("qSoftLock")] bool softLock = false, [QixName("qDeselectOnlyOneSelected")] bool deselectOnlyOneSelected = false)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path |
Path to the definition of the object to be selected.
For example, |
| System.Collections.Generic.IEnumerable<System.Int32> | rowIndices |
Array of row indexes to select, starting from 0.
If the array is empty |
| System.Collections.Generic.IEnumerable<System.Int32> | colIndices |
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:
If the array is empty |
| 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.Threading.Tasks.Task<System.Boolean> |
Remarks
This method applies to hypercubes, such as bar charts, tables and scatter plots.
SelectHyperCubeCellsAsync(AsyncHandle, String, IEnumerable<Int32>, IEnumerable<Int32>, Boolean, Boolean)
Makes selections in multiple dimensions and measures.
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
Task<bool> SelectHyperCubeCellsAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qRowIndices")] IEnumerable<int> rowIndices, [QixName("qColIndices")] IEnumerable<int> colIndices, [QixName("qSoftLock")] bool softLock = false, [QixName("qDeselectOnlyOneSelected")] bool deselectOnlyOneSelected = false)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | path |
Path to the definition of the object to be selected.
For example, |
| System.Collections.Generic.IEnumerable<System.Int32> | rowIndices |
Array of row indexes to select, starting from 0.
If the array is empty |
| System.Collections.Generic.IEnumerable<System.Int32> | colIndices |
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:
If the array is empty |
| 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.Threading.Tasks.Task<System.Boolean> |
Remarks
This method applies to hypercubes, such as bar charts, tables and scatter plots.
SelectHyperCubeCellsAsync<T>(AsyncHandle, Func<Response, T>, String, IEnumerable<Int32>, IEnumerable<Int32>, Boolean, Boolean)
Makes selections in multiple dimensions and measures.
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
Task<T> SelectHyperCubeCellsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qPath")] string path, [QixName("qRowIndices")] IEnumerable<int> rowIndices, [QixName("qColIndices")] IEnumerable<int> colIndices, [QixName("qSoftLock")] bool softLock = false, [QixName("qDeselectOnlyOneSelected")] bool deselectOnlyOneSelected = false)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | path |
Path to the definition of the object to be selected.
For example, |
| System.Collections.Generic.IEnumerable<System.Int32> | rowIndices |
Array of row indexes to select, starting from 0.
If the array is empty |
| System.Collections.Generic.IEnumerable<System.Int32> | colIndices |
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:
If the array is empty |
| 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.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Remarks
This method applies to hypercubes, such as bar charts, tables and scatter plots.
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!