Skip to main content Skip to complementary content

CollapseTopAsync Method

Overloads

CollapseTopAsync(String, Int32, Int32, Boolean)

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.

CollapseTopAsync(AsyncHandle, String, Int32, Int32, Boolean)

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.

CollapseTopAsync(String, Int32, Int32, Boolean)

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.

Declaration

      public Task CollapseTopAsync([QixName("qPath")] string path, [QixName("qRow")] int row, [QixName("qCol")] int col, [QixName("qAll")] bool all)
    

Parameters

Type Name Description
System.String path

Path to the definition of the object to be collapsed For example, /qHyperCubeDef .

System.Int32 row

Row index. The index is based on the top dimension indexes. Indexing starts from 0.

System.Int32 col

Column index in the data matrix. Indexing starts from 0.

System.Boolean all

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).

Returns

Type Description
System.Threading.Tasks.Task

Implements

CollapseTopAsync(AsyncHandle, String, Int32, Int32, Boolean)

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.

Declaration

      public Task CollapseTopAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qRow")] int row, [QixName("qCol")] int col, [QixName("qAll")] bool all)
    

Parameters

Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.String path

Path to the definition of the object to be collapsed For example, /qHyperCubeDef .

System.Int32 row

Row index. The index is based on the top dimension indexes. Indexing starts from 0.

System.Int32 col

Column index in the data matrix. Indexing starts from 0.

System.Boolean all

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).

Returns

Type Description
System.Threading.Tasks.Task

Implements

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!