GenericObject.SelectPivotCellsAsync Method (String, IEnumerable(NxSelectionCell), Boolean, Boolean, String)

GenericObject SelectPivotCellsAsync Method (String, IEnumerable NxSelectionCell , Boolean, Boolean, 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<bool> SelectPivotCellsAsync(
	string path,
	IEnumerable<NxSelectionCell> selections,
	bool softLock = false,
	bool deselectOnlyOneSelected = false,
	string userHandle = null
)

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

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

Public Function SelectPivotCellsAsync ( 
	path As String,
	selections As IEnumerable(Of NxSelectionCell),
	Optional softLock 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 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.

userHandle (Optional): Type: System String
Handle identifier

Return Value

Type:

Task

Boolean

Implements

IGenericObject SelectPivotCellsAsync(String, IEnumerable NxSelectionCell , Boolean, Boolean, String)