Skip to main content Skip to complementary content

IHyperCube Interface

Namespace: Qlik.Engine
Assembly: Qlik.Engine.dll

Renders the properties of a hypercube. Is the layout for HyperCubeDef.

For more information about the definition of a hypercube, see Generic object.

Syntax

[ValueClass]
public interface IHyperCube : IAbstractStructure

Properties

Name Description
CalcCondMsg

The message displayed if calculation condition is not fulfilled.

JSON property name: qCalcCondMsg

ColumnOrder

The order of the columns.

JSON property name: qColumnOrder

DataPages

Set of data.

Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

JSON property name: qDataPages

DimensionInfo

Information on the dimension.

JSON property name: qDimensionInfo

EffectiveInterColumnSortOrder

Sort order of the columns in the hypercube.

Column numbers are separated by a comma.

Example: [1,0,2] means that the first column to be sorted was the column 1, followed by the column 0 and the column 2.

JSON property name: qEffectiveInterColumnSortOrder

Error

This parameter is optional and is displayed in case of error.

JSON property name: qError

GrandTotalRow

Aggregate for measures of all values in the field.

The result value depends on the qAggrFunc defined in HyperCubeDef.

JSON property name: qGrandTotalRow

HasOtherValues

True if other row exists.

JSON property name: qHasOtherValues

IndentMode

Is used for pivot tables only.

If set to true, the formatting of the results is slightly different.

This property is optional.

JSON property name: qIndentMode

LastExpandedPos

Is used for pivot tables only.

Position of the last expended cell.

This property is optional.

JSON property name: qLastExpandedPos

MeasureInfo

Information on the measure.

JSON property name: qMeasureInfo

Mode

Information about the mode of the visualization.

JSON property name: qMode

NoOfLeftDims

Number of left dimensions.

Default value is -1.

The index related to each left dimension depends on the position of the pseudo dimension (if any).

For example, a pivot table with:

* Four dimensions in the following order: Country, City, Product and Category

* One pseudo dimension in position 1

* Three left dimensions.

implies that:

* The index 0 corresponds to the left dimension Country.

* The index 1 corresponds to the pseudo dimension.

* The index 2 corresponds to the left dimension City.

* Product and Category are top dimensions.

Another example:

* Four dimensions in the following order: Country, City, Product and Category.

* One pseudo dimension in position -1.

* Three left dimensions.

implies that:

* The index -1 corresponds to the pseudo dimension; the pseudo dimension is the most to the right.

* The index 0 corresponds to the left dimension Country.

* The index 1 corresponds to the left dimension City.

* The index 2 corresponds to the left dimension Product.

* Category is a top dimension.

JSON property name: qNoOfLeftDims

PivotDataPages

Set of data for pivot tables.

Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

JSON property name: qPivotDataPages

Size

Defines the size of the hypercube.

JSON property name: qSize

StackedDataPages

Set of data for stacked tables.

Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

JSON property name: qStackedDataPages

StateName

Name of the alternate state.

Default is current selections $ .

JSON property name: qStateName

Title

Title of the hypercube, for example the title of a chart.

JSON property name: qTitle

TreeNodesOnDim

The total number of nodes on each dimension (only applicable when qMode = T ).

JSON property name: qTreeNodesOnDim

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!