GenericObjectRangeSelectHyperCubeValuesAsync Method (String, IEnumerableNxRangeSelectInfo, IEnumerableInt32, Boolean, Boolean, AsyncHandle) |
Make range selections in measures.
This method applies to hypercubes. For example, bar charts, tables and scatter plots.
Namespace: Qlik.EngineAssembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax public Task<bool> RangeSelectHyperCubeValuesAsync(
string path,
IEnumerable<NxRangeSelectInfo> ranges,
IEnumerable<int> columnsToSelect = null,
bool orMode = false,
bool deselectOnlyOneSelected = false,
AsyncHandle asyncHandle = null
)
Public Function RangeSelectHyperCubeValuesAsync (
path As String,
ranges As IEnumerable(Of NxRangeSelectInfo),
Optional columnsToSelect As IEnumerable(Of Integer) = Nothing,
Optional orMode As Boolean = false,
Optional deselectOnlyOneSelected As Boolean = false,
Optional asyncHandle As AsyncHandle = Nothing
) As Task(Of Boolean)
Parameters
- path
- Type: SystemString
Path to the definition of the object to be selected.
For example, /qHyperCubeDef.
This parameter is mandatory. - ranges
- Type: System.Collections.GenericIEnumerableNxRangeSelectInfo
Ranges of selection
This parameter is mandatory. - columnsToSelect (Optional)
- Type: System.Collections.GenericIEnumerableInt32
Indicates which dimensions to select.
The dimensions numbering starts at 0 (first dimension is 0).
If the array is empty, all dimensions are selected.
This parameter is optional. - orMode (Optional)
- Type: SystemBoolean
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.
This parameter is optional. The default value is false. - deselectOnlyOneSelected (Optional)
- Type: SystemBoolean
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. - asyncHandle (Optional)
- Type: Qlik.EngineAsyncHandle
Handle to asyncronous method request
Return Value
Type:
TaskBooleanImplements
IGenericObjectRangeSelectHyperCubeValuesAsync(String, IEnumerableNxRangeSelectInfo, IEnumerableInt32, Boolean, Boolean, AsyncHandle)See Also