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

GenericObjectSelectPivotCellsAsync Method (String, IEnumerableNxSelectionCell, Boolean, Boolean, AsyncHandle)

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 cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.

** Stacked table **

Makes selections in the left dimension cells of a stacked table or in the data matrix.

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.1.0.0 (1.1.0.0)

Syntax

Copy

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

Public Function SelectPivotCellsAsync ( 
	path As String,
	selections As IEnumerable(Of NxSelectionCell),
	Optional softLock 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 For example, /qHyperCubeDef. This parameter is mandatory.
selections: Type: System.Collections.GenericIEnumerableNxSelectionCell
Information about the selections to perform
softLock (Optional): Type: SystemBoolean
Set to true to ignore locks; in that case, locked fields can be selected. This parameter is optional.
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

Parameters

Return Value

Implements

Reference