HyperCube

Renders the properties of a hypercube. Is the layout for HyperCubeDef. For more information about the definition of a hypercube, see Generic object.

What is returned in HyperCube depends on the type of the hypercube (straight, pivot or stacked table, or tree) and on the method called (GetLayout, GetHyperCubeData, GetHyperCubePivotData, GetHyperCubeStackData, GetHyperCubeTreeData).



Properties

Name Description Type
qStateName

Name of the alternate state. Default is current selections $ .

String
qSize

Defines the size of the hypercube.

Size
qError

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

NxValidationError
qDimensionInfo

Information on the dimension.

Array of NxDimensionInfo
qMeasureInfo

Information on the measure.

Array of NxMeasureInfo
qEffectiveInterColumnSortOrder

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.

Array of Integers
qGrandTotalRow

Aggregate for measures of all values in the field. The result value depends on the qAggrFunc defined in HyperCubeDef.

Array of NxCell
qDataPages

Set of data. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

Array of NxDataPage
qPivotDataPages

Set of data for pivot tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

Array of NxPivotPage
qStackedDataPages

Set of data for stacked tables. Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.

Array of NxStackPage
qMode

Information about the mode of the visualization.

One of:

  • S or DATA_MODE_STRAIGHT
  • P or DATA_MODE_PIVOT
  • K or DATA_MODE_PIVOT_STACK
  • T or DATA_MODE_TREE
String
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:

  • 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.
Integer
qIndentMode

Is used for pivot tables only. If set to true, the formatting of the results is slightly different. This property is optional.

Boolean
qLastExpandedPos

Is used for pivot tables only. Position of the last expended cell. This property is optional.

NxCellPosition
qHasOtherValues

True if other row exists.

Boolean
qTitle

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

String
qTreeNodesOnDim

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

Array of Integers
qCalcCondMsg

The message dislayed if calculation condition is not fulfilled.

String
qColumnOrder

The order of the columns.

Array of Integers