HyperCubeDef
Defines the properties of a hypercube. For more information about the definition of a hypercube, see Generic object.
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 |
Defines the 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 should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure. |
Array of Integers |
qSuppressZero |
Removes zero values. |
Boolean |
qSuppressMissing |
Removes missing values. |
Boolean |
qInitialDataFetch |
Initial data set. |
Array of NxPage |
qReductionMode |
One of:
|
String |
qMode |
Defines the way the data are handled internally by the engine. Default value is DATAMODE_STRAIGHT_ . A pivot table can contain several dimensions and measures whereas a stacked pivot table can contain several dimensions but only one measure. One of:
|
String |
qPseudoDimPos | Integer | |
qNoOfLeftDims |
Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with:
implies that:
Another example:
Implies that:
|
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 |
qSortbyYValue |
To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table. |
Integer |
qTitle |
Title of the hypercube, for example the title of a chart. |
StringExpr |
qCalcCondition |
Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the hypercube is not calculated and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional. |
NxCalcCond |
qColumnOrder |
The order of the columns. |
Array of Integers |