Renders the properties of a hypercube. Is the layout for HyperCubeDef.
For more information about the definition of a hypercube, see Generic objects.
Information noteWhat 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
HyperCube 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.
Null or 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 Integer
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
qTreeNodesOnDim
The total number of nodes on each dimension (only applicable when qMode = T).
Array of Integer
qMode
Information about the mode of the visualization.
One of:
S for DATA_MODE_STRAIGHT; straight table representation
P for DATA_MODE_PIVOT; pivot table representation
K for DATA_MODE_PIVOT_STACK; stacked table representation
T for DATA_MODE_TREE; tree 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:
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.
Null or NxCellPosition
qHasOtherValues
-
Boolean
Size properties
Name
Description
Type
qcx
Number of pixels on the x axis.
Integer
qcy
Number of pixels on the y axis.
Integer
NxValidationError properties
Name
Description
Type
qErrorCode
Error code.
This parameter is always displayed in case of error.
Integer
qContext
Context related to the error, from the user app domain.
It can be the identifier of an object, a field name, a table name.
This parameter is optional.
String
qExtendedMessage
Internal information from the server.
This parameter is optional.
String
NxDimensionInfo properties
Name
Description
Type
qFallbackTitle
Corresponds to the label of the dimension that is selected.
If the label is not defined then the field name is used.
String
qApprMaxGlyphCount
Length of the longest value in the field.
Integer
qCardinal
Number of distinct field values.
Integer
qLocked
Is set to true if the field is locked.
Boolean
qSortIndicator
Sort indicator.
The default value is no sorting.
This parameter is optional.
One of:
N for no sorting
A for sorting ascending
D for sorting descending
qGroupFallbackTitles
Array of dimension labels.
Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group).
Array of String
qGroupPos
Index of the dimension that is currently in use.
qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups.
Integer
qStateCounts
Number of values in a particular state.
NxStateCounts
qTags
Gives information on a field. For example, it can return the type of the field.
Examples: key, text, ASCII
Array of String
qError
This parameter is optional.
Gives information on the error.
Null or NxValidationError
qDimensionType
Binary format of the field.
One of:
D for discrete (String)
N for numeric (Double)
T for Time (Timestamp)
qReverseSort
If set to true, it inverts the sort criteria in the field.
Boolean
qGrouping
Defines the grouping.
One of:
N for no grouping
H for drill-down
C for cyclic
qIsSemantic
If set to true, it means that the field is a semantic.
Boolean
qNumFormat
Format of the field.
This parameter is optional.
FieldAttributes
qIsAutoFormat
This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition.
Boolean
qGroupFieldDefs
Array of field names.
Array of String
qAttrExprInfo
Array of attribute expressions.
Array of NxAttrExprInfo
qMin
Minimum value.
Double
qMax
Maximum value.
Double
qContinuousAxes
Is continuous axis used.
Boolean
qIsCyclic
Is a cyclic dimension used.
Boolean
qDerivedField
Is derived field is used as a dimension.
Boolean
qAttrDimInfo
Array of attribute dimensions.
Array of NxAttrDimInfo
NxStateCounts properties
Name
Description
Type
qLocked
Number of values in locked state.
Integer
qSelected
Number of values in selected state.
Integer
qOption
Number of values in optional state.
Integer
qDeselected
Number of values in deselected state.
Integer
qAlternative
Number of values in alternative state.
Integer
qExcluded
Number of values in excluded state.
Integer
qSelectedExcluded
Number of values in selected excluded state.
Integer
qLockedExcluded
Number of values in locked excluded state.
Integer
NxMeasureInfo properties
Name
Description
Type
qFallbackTitle
Corresponds to the label of the measure.
If the label is not defined then the measure name is used.
String
qApprMaxGlyphCount
Length of the longest value in the field.
Integer
qCardinal
Number of distinct field values.
Integer
qSortIndicator
Sort indicator.
The default value is no sorting.
This parameter is optional.
One of:
N for no sorting
A for sorting ascending
D for sorting descending
qNumFormat
Format of the field.
This parameter is optional.
FieldAttributes
qIsAutoFormat
This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
Boolean
qMin
Lowest value in the range.
Double
qMax
Highest value in the range.
Double
qError
This parameter is optional.
Gives information on the error.
Null or NxValidationError
qReverseSort
If set to true, it inverts the sort criteria in the field.
Boolean
qAttrExprInfo
List of attribute expressions.
Array of NxAttrExprInfo
qAttrDimInfo
List of attribute dimensions.
Array of NxMeasureInfo
Field attributes
Name
Description
Type
qType
Type of the field.
Default is U.
One of:
• U for UNKNOWN type.
• A for ASCII; Numeric fields values contain only standard ASCII characters.
• I for INTEGER; Numeric fields values are shown as integer numbers.
• R for REAL; Numeric fields values are shown as real numbers.
• F for FIX; Numeric fields values are shown as numbers with a fix number of decimals.
• M for MONEY; Numeric fields values are shown as in the money format.
• D for DATE; Numeric fields values are shown as dates.
• T for TIME; Numeric fields values are shown as times.
• TS TIMESTAMP; Numeric fields values are shown as time stamps.
• IV for INTERVAL; Numeric fields values are shown as intervals.
qnDec
Number of decimals.
Default is 10.
Integer between 0 and 15.
qUseThou
Defines whether or not a thousands separator must be used.
Default is 0.
One of:
0 for false
1 for true
qFmt
Defines the format pattern that applies to qText.
Is used in connection to the type of the field (parameter qType).
If the element number is a negative number, it means that the returned value is not an element number.
You can get the following negative values:
-1: the cell is a Total cell. It shows a total.
-2: the cell is collapsed. Applies to pivot tables.
-3: the cell belongs to the group Others.
-4: the cell is empty. Applies to pivot tables.
Integer
qState
State of the value.
The default state for a measure is L.
One of:
L for Locked
S for Selected
O for Optional
D for Deselected
A for Alternative
X for eXcluded
XS for eXcluded Selected
XL for eXcluded Locked
qIsEmpty
Is set to true, if qText and qNum are empty.
This parameter is optional. The default value is false.
Boolean
qIsTotalCell
Is set to true if a total is displayed in the cell.
This parameter is optional. The default value is false.
Not applicable to list objects.
Boolean
qIsOtherCell
Is set to true if the cell belongs to the group Others.
Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp.
This parameter is optional. The default value is false.
Not applicable to list objects.
Boolean
qFrequency
Frequency of the value.
This parameter is optional.
String
qHighlightRanges
Search hits.
The search hits are highlighted.
This parameter is optional.
Null or NxHighlightRanges
qAttrExps
Attribute expression values.
Null or NxAttributeExpressionValues
qIsNull
Is set to true if the value is Null.
Boolean
qAttrDims
Attribute dimensions values.
Null or NxAttributeDimValues
NxAttributeExpressionValues properties
Name
Description
Type
qValues
List of attribute expressions values.
Array of NxSimpleValue
NxSimpleValue properties
Name
Description
Type
qText
Text related to the attribute expression value.
No text is returned if the attribute expression value is a numeric.
This property is optional.
String
qNum
Numeric value of the attribute expression.
This property is set to NaN (Not a Number) if the attribute expression value is not a numeric.
Numerical values are not returned as text.
Double
NxDataPage properties
Name
Description
Type
qMatrix
Array of data.
Array of NxCellRows
qTails
Array of tails.
Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail.
If there is no tail, the array is empty [ ].
Array of NxGroupTail
qArea
Size and offset of the data in the matrix.
Rect
qIsReduced
Is set to true, if the data have been reduced.
The default value is false.
Boolean
NxCellRows properties
Name
Description
Type
NxCellRows
Array of data.
Array of NxCell
NxGroupTail properties
Name
Description
Type
qUp
Number of elements that are part of the previous tail.
This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight.
Is not shown if the value is 0.
This parameter is optional.
Integer
qDown
Number of elements that are part of the next tail.
This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight
Is not shown if the value is 0.
This parameter is optional.
Integer
Rectangle position values
Name
Description
Type
qLeft
Position from the left.
Corresponds to the first column.
Integer
qTop
Position from the top.
Corresponds to the first row.
Integer
qWidth
Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef).
Integer
qHeight
Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef).
Integer
NxPivotPage properties
Name
Description
Type
qLeft
Information about the left dimension values of a pivot table.
Array of NxPivotDimensionCell
qTop
Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.
In this example, the bar chart has one dimension and one measure. No initial values are fetched. The aggregate value for the measure is 55. This chart is defined in HyperCubeDef.
