MultiRangeSelectHyperCubeValuesAsync Method
Overloads
| MultiRangeSelectHyperCubeValuesAsync(String, IEnumerable<NxMultiRangeSelectInfo>, Boolean, Boolean) |
Makes multiple range selections in 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 |
|
| MultiRangeSelectHyperCubeValuesAsync(AsyncHandle, String, IEnumerable<NxMultiRangeSelectInfo>, Boolean, Boolean) |
Makes multiple range selections in 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 |
|
| MultiRangeSelectHyperCubeValuesAsync<T>(AsyncHandle, Func<Response, T>, String, IEnumerable<NxMultiRangeSelectInfo>, Boolean, Boolean) |
Makes multiple range selections in 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 |
MultiRangeSelectHyperCubeValuesAsync(String, IEnumerable<NxMultiRangeSelectInfo>, Boolean, Boolean)
Makes multiple range selections in 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> MultiRangeSelectHyperCubeValuesAsync([QixName("qPath")] string path, [QixName("qRanges")] IEnumerable<NxMultiRangeSelectInfo> ranges, [QixName("qOrMode")] bool orMode = 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<NxMultiRangeSelectInfo> | ranges |
Ranges of selections. |
| System.Boolean | orMode |
Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false. |
| 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. For example, bar charts, tables and scatter plots.
MultiRangeSelectHyperCubeValuesAsync(AsyncHandle, String, IEnumerable<NxMultiRangeSelectInfo>, Boolean, Boolean)
Makes multiple range selections in 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> MultiRangeSelectHyperCubeValuesAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qRanges")] IEnumerable<NxMultiRangeSelectInfo> ranges, [QixName("qOrMode")] bool orMode = 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<NxMultiRangeSelectInfo> | ranges |
Ranges of selections. |
| System.Boolean | orMode |
Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false. |
| 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. For example, bar charts, tables and scatter plots.
MultiRangeSelectHyperCubeValuesAsync<T>(AsyncHandle, Func<Response, T>, String, IEnumerable<NxMultiRangeSelectInfo>, Boolean, Boolean)
Makes multiple range selections in 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> MultiRangeSelectHyperCubeValuesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qPath")] string path, [QixName("qRanges")] IEnumerable<NxMultiRangeSelectInfo> ranges, [QixName("qOrMode")] bool orMode = 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<NxMultiRangeSelectInfo> | ranges |
Ranges of selections. |
| System.Boolean | orMode |
Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. The default value is false. |
| 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. For example, 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!