SelectHyperCubeValuesAsync Method
Overloads
| SelectHyperCubeValuesAsync(String, Int32, IEnumerable<Int32>, Boolean) |
Selects some values in one dimension. The values are identified by their element numbers. 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 |
|
| SelectHyperCubeValuesAsync(AsyncHandle, String, Int32, IEnumerable<Int32>, Boolean) |
Selects some values in one dimension. The values are identified by their element numbers. 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 |
|
| SelectHyperCubeValuesAsync<T>(AsyncHandle, Func<Response, T>, String, Int32, IEnumerable<Int32>, Boolean) |
Selects some values in one dimension. The values are identified by their element numbers. 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 |
SelectHyperCubeValuesAsync(String, Int32, IEnumerable<Int32>, Boolean)
Selects some values in one dimension.
The values are identified by their element numbers.
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
public Task<bool> SelectHyperCubeValuesAsync([QixName("qPath")] string path, [QixName("qDimNo")] int dimNo, [QixName("qValues")] IEnumerable<int> values, [QixName("qToggleMode")] bool toggleMode)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path |
Path to the definition of the object to be selected.
For example, |
| System.Int32 | dimNo |
Dimension number or index to select. Dimension numbers/index start from 0. |
| System.Collections.Generic.IEnumerable<System.Int32> | values |
Element numbers of the field to select. You can select multiple elements; the separator is the comma. |
| System.Boolean | toggleMode |
Set to true to toggle. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Implements
Remarks
This method applies to charts, tables and scatter plots.
SelectHyperCubeValuesAsync(AsyncHandle, String, Int32, IEnumerable<Int32>, Boolean)
Selects some values in one dimension.
The values are identified by their element numbers.
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
public Task<bool> SelectHyperCubeValuesAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qDimNo")] int dimNo, [QixName("qValues")] IEnumerable<int> values, [QixName("qToggleMode")] bool toggleMode)
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.Int32 | dimNo |
Dimension number or index to select. Dimension numbers/index start from 0. |
| System.Collections.Generic.IEnumerable<System.Int32> | values |
Element numbers of the field to select. You can select multiple elements; the separator is the comma. |
| System.Boolean | toggleMode |
Set to true to toggle. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Implements
Remarks
This method applies to charts, tables and scatter plots.
SelectHyperCubeValuesAsync<T>(AsyncHandle, Func<Response, T>, String, Int32, IEnumerable<Int32>, Boolean)
Selects some values in one dimension.
The values are identified by their element numbers.
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
public Task<T> SelectHyperCubeValuesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qPath")] string path, [QixName("qDimNo")] int dimNo, [QixName("qValues")] IEnumerable<int> values, [QixName("qToggleMode")] bool toggleMode)
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.Int32 | dimNo |
Dimension number or index to select. Dimension numbers/index start from 0. |
| System.Collections.Generic.IEnumerable<System.Int32> | values |
Element numbers of the field to select. You can select multiple elements; the separator is the comma. |
| System.Boolean | toggleMode |
Set to true to toggle. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Implements
Remarks
This method applies to 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!