GenericObject.SelectPivotCellsAsync(T) Method (String, IEnumerable(NxSelectionCell), Boolean, Boolean, Func(Response, T), String)

GenericObject SelectPivotCellsAsync T Method (String, IEnumerable NxSelectionCell , Boolean, Boolean, Func Response, T , String)

Qlik Sense .NET SDK - API Reference

This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P or K.

** Pivot table **

Makes selections in the top or left dimension values of a pivot table. Only expanded dimensions can be selected.

To select the calculated values of a pivot table, use the SelectHyperCubeCells method.

** Stacked table **

Makes selections in the left dimension values of a stacked table.

There is no top dimensions in a stacked table.

** Example of a pivot table **

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

Syntax

C++

Copy to Clipboard Print

public Task<T> SelectPivotCellsAsync<T>(
	string path,
	IEnumerable<NxSelectionCell> selections,
	bool softLock = false,
	bool deselectOnlyOneSelected = false,
	Func<Response, T> onResult,
	string userHandle = null
)

public Task<T> SelectPivotCellsAsync<T>(
	string path,
	IEnumerable<NxSelectionCell> selections,
	bool softLock = false,
	bool deselectOnlyOneSelected = false,
	Func<Response, T> onResult,
	string userHandle = null
)

Public Function SelectPivotCellsAsync(Of T) ( 
	path As String,
	selections As IEnumerable(Of NxSelectionCell),
	Optional softLock As Boolean = false,
	Optional deselectOnlyOneSelected As Boolean = false,
	onResult As Func(Of Response, T),
	Optional userHandle As String = Nothing
) As Task(Of T)

Public Function SelectPivotCellsAsync(Of T) ( 
	path As String,
	selections As IEnumerable(Of NxSelectionCell),
	Optional softLock As Boolean = false,
	Optional deselectOnlyOneSelected As Boolean = false,
	onResult As Func(Of Response, T),
	Optional userHandle As String = Nothing
) As Task(Of T)

Parameters

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

selections: Type: System.Collections.Generic IEnumerable NxSelectionCell
Information about the selections to perform

softLock (Optional): Type: System Boolean
Set to true to ignore locks; in that case, locked fields can be selected. This parameter is optional.

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.

onResult: Type: System Func Response, T
Continuation function

userHandle (Optional): Type: System String
Handle identifier

Type Parameters

T

Return Value

Type:

Task T

Implements

IGenericObject SelectPivotCellsAsync T (String, IEnumerable NxSelectionCell , Boolean, Boolean, Func Response, T , String)