Skip to main content Skip to complementary content

HyperCubeDef

Overview

Defines the properties of a hypercube.

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

Properties

Name Description Type
qStateName

Name of the alternate state.

Default is current selections $.

String
qDimensions Array of dimensions.

Array of NxDimension

qMeasures Array of measures.

Array of NxMeasure

qInterColumnSortOrder

Order the columns of the hypercube should be sorted.

Column numbers are separated by a comma.

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

If the list does not contain all columns, the order for the columns that are not in the list is the order of appearance from left to right.

The index of the pseudo-dimension (if any) is -1.

Array of Integer
qSuppressZero Removes zero values.

Boolean.

Default is false.

qSuppressMissing Removes missing values.

Boolean.

Default is false.

qInitialDataFetch Initial data set.

Array of NxPage

qMode

Defines the way the data are handled internally by the engine.

Default value is DATA_MODE_STRAIGHT

One of:

  • S for DATA_MODE_STRAIGHT; straight table representation
  • P for DATA_MODE_PIVOT; pivot table representation
  • K for DATA_MODE_STACK; stacked table representation

qNoOfLeftDims

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:

  • 4 dimensions in the following order: Country, City, Product and Category
  • one pseudo dimension in position 1
  • 3 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:

  • 4 dimensions in the following order: Country, City, Product and Category
  • one pseudo dimension in position -1
  • 3 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.
Integer
qAlwaysFullyExpanded

If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells.

The default value is false.

Boolean
qMaxStackedCells

Maximum number of cells for an initial data fetch (set in qInitialDataFetch) when in stacked mode (qMode is K).

The default value is 5000.

Integer
qPopulateMissing

If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string.

The default value is false.

Boolean
qShowTotalsAbove

If set to true, the total (if any) is shown on the first row.

The default value is false.

Boolean
qIndentMode

This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row.

The default value is false.

Boolean
qCalcCond

Specifies a calculation condition, which must be fulfilled for the hypercube to be (re)calculated.

As long as the condition is not met, the engine does not perform a new calculation.

This property is optional. By default, there is no calculation condition.

ValueExpr

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!