GenericObject.CollapseTopAsync Method

GenericObject CollapseTopAsync Method

Qlik Sense .NET SDK - API Reference

Collapses the top dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded.

In the definition of the hypercube (in HyperCubeDef), the parameter qAlwaysFullyExpanded must be set to false.

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 CollapseTopAsync(
	string path,
	int row,
	int col,
	bool all,
	string userHandle = null
)

public Task CollapseTopAsync(
	string path,
	int row,
	int col,
	bool all,
	string userHandle = null
)

Public Function CollapseTopAsync ( 
	path As String,
	row As Integer,
	col As Integer,
	all As Boolean,
	Optional userHandle As String = Nothing
) As Task

Public Function CollapseTopAsync ( 
	path As String,
	row As Integer,
	col As Integer,
	all As Boolean,
	Optional userHandle As String = Nothing
) As Task

Parameters

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

row: Type: System Int32
Row index. The index is based on the top dimension indexes. Indexing starts from 0.

col: Type: System Int32
Column index in the data matrix. Indexing starts from 0.

all: Type: System Boolean
If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

userHandle (Optional): Type: System String
Handle identifier

Return Value

Type:

Task

Implements

IGenericObject CollapseTopAsync(String, Int32, Int32, Boolean, String)