For more information about the definition of a hypercube, see Generic objects.
Properties
HyperCubeDef 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 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.
A pivot table can contain several dimensions and measures whereas a stacked pivot table can contain several dimensions but only one measure.
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. In that case, all dimensions are left dimensions.
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 (the position is defined in qInterColumnSortOrder)
qInterColumnSortOrder is (0,-1,1,2,3).
Three left dimensions (qNoOfLeftDims is set to 3).
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.
Three left dimensions (qNoOfLeftDims is set to 3).
One pseudo dimension.
The property qInterColumnSortOrder is left empty.
Implies that:
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.
The pseudo dimension 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
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.
One of:
• -1 for sorting descending
• 0 for no sorting
• 1 for sorting ascending
NxDimension properties
Name
Description
Type
qLibraryId
Refers to a dimension stored in the library.
String
qDef
Refers to a dimension stored in the hypercube.
Null or NxInlineDimensionDef
qNullSuppression
If set to true, no null values are returned.
Boolean
qOtherTotalSpec
Sets the dimension limits. Each dimension of a hypercube is configured separately.
Defines if some values (grouped as Others) should be grouped together in the visualization.
For example in a pie chart all values lower than 200 could be grouped together.
OtherTotalSpecProp
qShowAll
If set to true, all dimension values are shown.
Boolean
qOtherLabel
This property is used when some dimension limits are set.
Label of the Others group. The default label is Others.
Example:
"qOtherLabel":"=<label>"
or
"qOtherLabel":{"qExpr":"=<label>"}
Where:
<label> is the label of the Others group.
String
qTotalLabel
If this property is set, the total of the calculated values is returned.
The default label is Total.
Example:
"qTotalLabel":"=<label>"
or
"qTotalLabel":{"qExpr":"=<label>"}
Where:
<label> is the label of the Totalgroup.
String
qCalcCond
Specifies a calculation condition, which must be fulfilled for the dimension to be calculated.
If the calculation condition is not met, the dimension is excluded from the calculation.
By default, there is no calculation condition.
This property is optional.
ValueExpr
qAttributeExpressions
List of attribute expressions.
Array of NxAttrExprDef
qAttributeDimensions
List of attribute dimensions.
Array of NxAttrDimDef
Information noteEither qDef or qLibraryId must be set, but not both.
Information noteIf the dimension is set in the hypercube and not in the library, this dimension cannot be shared with other objects.
Information noteA dimension that is set in the library can be used by many objects.
NxInlineDimensionDef properties
Name
Description
Type
qGrouping
Used to define a cyclic group or drill-down group.
Default value is no grouping.
This parameter is optional.
One of:
N for no grouping
H for drill-down
C for cyclic
qFieldDefs
Array of field names.
When creating a grouped dimension, more than one field name is defined.
This parameter is optional.
Array of String
qFieldLabels
Array of field labels.
This parameter is optional.
Array of String
qLabelExpression
Label expression.
This parameter is optional.
String
qNumberPresentations
Defines the format of the value.
This parameter is optional.
Array of FieldAttributes
qReverseSort
If set to true, it inverts the sort criteria in the field.
Boolean
qSortCriterias
Defines the sorting criteria in the field.
Default is to sort by alphabetical order, ascending.
This parameter is optional.
Array of SortCriteria
qActiveField
Index of the active field in a cyclic dimension.
This parameter is optional. The default value is 0.
This parameter is used in case of cyclic dimensions (qGrouping is C).
Integer
OtherTotalSpecProp properties
Name
Description
Type
qOtherMode
Determines how many dimension values are displayed.
The default value is OTHER_OFF.
One of:
OTHER_OFF; do not limit the number of dimension values
OTHER_COUNTED; limit the dimension values to a specified number defined in HyperCubeDef.
OTHER_ABS_LIMITED; limit the dimension values to an absolute value defined in HyperCubeDef.
OTHER_ABS_ACC_TARGET; return the dimension values that accumulate to an absolute value. All rows up to the current row are accumulated and the result is compared to the specified absolute value. The absolute value is defined in HyperCubeDef.
OTHER_REL_LIMITED; limit the dimension values based on a percentage of the total. The total is the sum of all the dimension values. The percentage is defined in HyperCubeDef.
OTHER_REL_ACC_TARGET; return the dimension values that accumulate to a percentage of the total. All rows up to the current row are accumulated and the result is compared to the total of the dimension values. A percentage is calculated. This percentage is compared to the specified percentage, defined in HyperCubeDef.
qOtherCounted
Number of values to display. The number of values can be entered as a calculated formula.
This parameter is used when qOtherMode is set to OTHER_COUNTED.
"qv": "<expression>"
Where
<expression> is a string.
qOtherLimit
Value used to limit the dimension values. The limit can be entered as a calculated formula.
This parameter is used when qOtherMode is set to:
OTHER_ABS_LIMITED
OTHER_REL_LIMITED
OTHER_ABS_ACC_TARGET
OTHER_REL_ACC_TARGET
"qv": "<expression>"
Where
<expression> is a string.
qOtherLimitMode
Sets the limit for the Others mode.
This parameter is used when qOtherMode is set to:
OTHER_ABS_LIMITED
OTHER_REL_LIMITED
OTHER_ABS_ACC_TARGET
OTHER_REL_ACC_TARGET
One of:
OTHER_GE_LIMIT; include the values greater or equal
OTHER_LE_LIMIT; include the values lower or equal
OTHER_GT_LIMIT; include the values strictly greater than
OTHER_LT_LIMIT; include the values strictly lower than
Default: OTHER_GT_LIMIT
qSuppressOther
If set to true, the group Others is not displayed as a dimension value.
The default value is false.
Boolean
qForceBadValueKeeping
This parameter is used when qOtherMode is set to:
OTHER_ABS_LIMITED
OTHER_REL_LIMITED
OTHER_ABS_ACC_TARGET
OTHER_REL_ACC_TARGET
and when the dimension values include not numeric values.
Set this parameter to true to include text values in the returned values.
The default value is true.
Boolean
qApplyEvenWhenPossiblyWrongResult
Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes.
For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe.
The default value is true.
Boolean
qGlobalOtherGrouping
This parameter applies to inner dimensions.
If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored.
The default value is false.
Boolean
qOtherCollapseInnerDimensions
If set to true, it collapses the inner dimensions (if any) in the group Others.
The default value is false.
Boolean
qOtherSortMode
Defines the sort order of the dimension values.
The default value is OTHER_SORT_DESCENDING.
One of:
OTHER_SORT_DEFAULT; sort by load order
OTHER_SORT_DESCENDING; sort by descending values
OTHER_SORT_ASCENDING; sort by ascending values
qTotalMode
If set to TOTAL_EXPR, the total of the dimension values is returned.
The default value is TOTAL_OFF.
One of:
TOTAL_OFF
TOTAL_EXPR
qReferencedExpression
This parameter applies when there are several measures.
Name of the measure to use for the calculation of Others for a specific dimension.
String
NxMeasure properties
Name
Description
Type
qLibraryId
Refers to a measure stored in the library.
String
qDef
Refers to a measure stored in the hypercube.
Null or NxInlineMeasureDef
qSortBy
Defines the sort criteria.
The default value is sort by ascending alphabetic order.
This property is optional.
SortCriteria
qAttributeExpressions
List of attribute expressions.
Array of NxAttrExprDef
qCalcCond
Specifies a calculation condition, which must be fulfilled for the measure to be calculated.
If the calculation condition is not met, the measure is excluded from the calculation.
By default, there is no calculation condition.
This property is optional.
ValueExpr
qAttributeDimensions
List of attribute dimensions.
Array of NxAttrDimDef
Information noteEither qDef or qLibraryId must be set, but not both.
Information noteIf the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.
Information noteA measure that is set in the library can be used by many objects.
Information note
expressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure.
Attribute expressions do not affect the layout of an object. The sorting order is unchanged.
NxInlineMeasureDef properties
Name
Description
Type
qLabel
Name of the measure.
An empty string is returned as a default value.
This parameter is optional.
String
qLabelExpression
Label expression.
This parameter is optional.
String
qDescription
Description of the measure.
An empty string is returned as a default value.
This parameter is optional.
String
qTags
Name connected to the measure that is used for search purposes.
A measure can have several tags.
This parameter is optional.
Array of String
qGrouping
Default value is no grouping.
This parameter is optional.
One of:
N for no grouping
H for drill-down
C for cyclic
qDef
Definition of the expression in the measure.
Example: Sum (OrderTotal)
This parameter is mandatory.
String
qNumFormat
Format of the field.
This parameter is optional.
FieldAttributes
qRelative
If set to true, percentage values are returned instead of absolute numbers.
Default value is false.
This parameter is optional.
Boolean
qBrutalSum
If set to true, the sum of rows total should be used rather than real expression total.
This parameter is optional and applies to straight tables.
Default value is false.
If using the Qlik Sense interface, it means that the total mode is set to Expression Total.
Boolean
qAggrFunc
Aggregate function.
For more information on the aggregate function syntax, see the section Working with Qlik Sense on the online help portal.
The default value is 0 (Sum of rows)
This parameter is optional.
String
qAccumulate
• 0 means no accumulation
• 1 means full accumulation (each y-value accumulates all previous y-values of the expression)
• ≥ 2 means accumulate as many steps as the qAccumulate value
Default value is 0.
This parameter is optional.
Integer
qReverseSort
If set to true, it inverts the sort criteria in the field.
Boolean
qActiveExpression
Index of the active expression in a cyclic measure. The indexing starts from 0.
The default value is 0.
This parameter is optional.
Integer
qExpressions
Array of expressions. This parameter is used in case of cyclic measures (qGrouping is C). List of the expressions in the cyclic group.
Array of String
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).
Sorts the field values according to their logical state (selected, optional, alternative or excluded).
One of:
• -1 for sorting descending
• 0 for no sorting
• 1 for sorting ascending
qSortByFrequency
Sorts the field values by frequency (number of occurrences in the field).
One of:
• -1 for sorting ascending
• 0 for no sorting
• 1 for sorting descending
qSortByNumeric
Sorts the field values by numeric value.
One of:
• -1 for sorting descending
• 0 for no sorting
• 1 for sorting ascending
qSortByAscii
Sorts the field by alphabetical order.
One of:
• -1 for sorting descending
• 0 for no sorting
• 1 for sorting ascending
qSortByLoadOrder
Sorts the field values by the initial load order.
One of:
• -1 for sorting descending
• 0 for no sorting
• 1 for sorting ascending
qSortByExpression
Sorts the field by expression.
One of:
• -1 for sorting descending
• 0 for no sorting
• 1 for sorting ascending
qExpression
Sort by expression.
"qv": "<expression>"
Where
<expression> is a string.
NxAttrExprDef properties
Name
Description
Type
qExpression
Definition of the attribute expression.
Example: "Max(OrderID)"
String
qLibraryId
Definition of the attribute expression stored in the library.
Example: "MyGenericMeasure"
String
NxPage properties
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).