GenericObject.RangeSelectHyperCubeValuesAsync Method (String, IEnumerable(NxRangeSelectInfo), Boolean, Boolean, String)

GenericObject RangeSelectHyperCubeValuesAsync Method (String, IEnumerable NxRangeSelectInfo , Boolean, Boolean, String)

Qlik Sense .NET SDK - API Reference

Make range selections in measures.

This method applies to hypercubes. For example, bar charts, tables and scatter plots.

Namespace: Qlik.Engine
Assembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.0.1.0 (1.0.1.0)

Syntax

public Task<bool> RangeSelectHyperCubeValuesAsync(
	string path,
	IEnumerable<NxRangeSelectInfo> ranges,
	bool orMode = false,
	bool deselectOnlyOneSelected = false,
	string userHandle = null
)

public Task<bool> RangeSelectHyperCubeValuesAsync(
	string path,
	IEnumerable<NxRangeSelectInfo> ranges,
	bool orMode = false,
	bool deselectOnlyOneSelected = false,
	string userHandle = null
)

Public Function RangeSelectHyperCubeValuesAsync ( 
	path As String,
	ranges As IEnumerable(Of NxRangeSelectInfo),
	Optional orMode As Boolean = false,
	Optional deselectOnlyOneSelected As Boolean = false,
	Optional userHandle As String = Nothing
) As Task(Of Boolean)

Public Function RangeSelectHyperCubeValuesAsync ( 
	path As String,
	ranges As IEnumerable(Of NxRangeSelectInfo),
	Optional orMode As Boolean = false,
	Optional deselectOnlyOneSelected As Boolean = false,
	Optional userHandle As String = Nothing
) As Task(Of Boolean)

Parameters

path: Type: System String
Path to the definition of the object to be selected. For example, /qHyperCubeDef. This parameter is mandatory.

ranges: Type: System.Collections.Generic IEnumerable NxRangeSelectInfo
Ranges of selection This parameter is mandatory.

orMode (Optional): Type: System Boolean
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: System Boolean
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.

userHandle (Optional): Type: System String
Handle identifier

Return Value

Type:

Task

Boolean

Implements

IGenericObject RangeSelectHyperCubeValuesAsync(String, IEnumerable NxRangeSelectInfo , Boolean, Boolean, String)