qHyperCubeDef

Most visualization that comes built-in with Qlik Sense are based on a hypercube definition (qHyperCubeDef) on root level. A hypercube can contain both dimensions and measures. If selections are applied to a hypercube, only the selected values are displayed.

You can have multiple hypercubes in your properties (initialProperties). This allows you to make advanced visualizations that combine several data sets. If you have multiple hypercubes, you need to place them at different paths in your property structure.

Examples

Example: Hypercube definition in Chart template

initialProperties: {
	version: 1.0,
	qHyperCubeDef: {
		qDimensions: [],
		qMeasures: [],
		qInitialDataFetch: [{
			qWidth: 2,
			qHeight: 50
		}]
	}
},

Example: Multiple hypercubes definition

initialProperties : {
		version : 1.0,
		qHyperCubeDef : {
			qDimensions : [],
			qMeasures : [],
			qInitialDataFetch : [{
				qWidth : 10,
				qHeight : 50
			}]
		},
		second : {
			qHyperCubeDef : {
				qDimensions : [],
				qMeasures : [],
				qInitialDataFetch : [{
					qWidth : 10,
					qHeight : 50
			}]
		}
	}
}

Example: Enabling numerical sorting

By defining qInterColumnSortOrder, numerical sorting on the measure is enabled.

initialProperties : {
	version : 1.0,
	qHyperCubeDef : {
		qDimensions : [],
		qMeasures : [],
		qInterColumnSortOrder : [1,0]
		qInitialDataFetch : [{
			qWidth : 10,
			qHeight : 50
		}]
	}
},

Properties

Name	Type	Description
qStateName	String	Name of the alternate state. Default is $ (current selections).
qDimensions	Array of NxDimension	Array of dimensions. See: NxDimension.
qMeasures	Array of NxMeasure	Array of measures. See: NxMeasure.
qInterColumnSortOrder	Array of Integer.	The order in which 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.
qSuppressZero	Boolean	Removes zero values. Default is false.
qSuppressMissing	Boolean	Removes missing values. Default is false.
qInitialDataFetch	Array of NxPage	Initial data set. See: NxPage.
qMode	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	Defines the way the data are handled internally by the Qlik engine. Default value is S (DATA_MODE_STRAIGHT).
qNoOfLeftDims	Integer	Number of left dimensions. The index related to each left dimension depends on the position of the pseudo dimension (if any).
qAlwaysFullyExpanded	Boolean	If true, the cells are always expanded, meaning that it is not possible to collapse any cells. Default value is false.
qMaxStackedCells	Integer	Maximum number of cells for an initial data fetch (set in qInitialDataFetch) when in stacked mode (qMode is K).
qPopulateMissing	Boolean	If 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.

NxDimension

A dimension set in the hypercube cannot be shared with other objects.

Name	Type	Description
qLibraryId	String	Refers to a dimension stored in the library. Information noteMandatory if qDef is not set. Must not be set if qDef is set.
qDef	Null or NxInlineDimensionDef	Refers to a dimension stored in the hypercube. Information noteMandatory if qLibraryId is not set. Must not be set if qLibraryId is set. See: NxInlineDimensionDef
qNullSuppression	Boolean	If true, no null values are returned.
qOtherTotalSpec	OtherTotalSpecProp	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. See: OtherTotalSpecProp
qShowAll	Boolean	If true, all dimension values are shown.
qOtherLabel	String	This property is used when some dimension limits are set. Label of the Others group. Default label is Others.
qTotalLabel	String	If this property is set, the total of the calculated values is returned. Default label is Total.

Name	Type	Description
qGrouping	One of: N for no grouping H for drill-down C for cyclic	Used to define a cyclic group or drill-down group. This parameter is optional. Default value is N (no grouping).
qFieldDefs	Array of String.	Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
qFieldLabels	Array of String.	Array of field labels. This parameter is optional.
qSortCriterias	Array of SortCriteria.	Defines the sorting criteria in the field. This parameter is optional. Default is to sort by alphabetical order, ascending.
qNumberPresentations	Array of FieldAttributes.	Defines the format of the value. This parameter is optional.
qReverseSort	Boolean	If true, the sort criteria in the field is inverted.
qActiveFields	Integer	Index of the active field in a cyclic dimension. This parameter is optional. Default value is 0. Information note This parameter is used in case of cyclic dimensions (qGrouping = C).

Name	Type	Description
qOtherMode	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.	Determines how many dimension values are displayed. Default value is OTHER_OFF.
qOtherCounted	"qv": "<expression>" Where <expression> is a string.	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.
qOtherLimit	"qv": "<expression>" Where <expression> is a string.	Value used to limit the dimension values. The limit can be entered as a calculated formula. Default is OTHER_GT_LIMIT. This parameter is used when qOtherMode is set to: OTHER_ABS_LIMITED OTHER_REL_LIMITED OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET
qOtherLimitMode	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.	Sets the limit for the Others mode. Default is OTHER_GT_LIMIT. This parameter is used when qOtherMode is set to: OTHER_ABS_LIMITED OTHER_REL_LIMITED OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET
qSuppressOther	Boolean	If set to true, the group Others is not displayed as a dimension value. Default value is false.
qForceBadValueKeeping	Boolean	Set this parameter to true to include text values in the returned values. Default value is true. 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 non-numeric values.
qApplyEvenWhenPossiblyWrongResult	Boolean	Set this parameter to true to allow the calculation of Others even if the Qlik engine detects potential mistakes. Default value is true. 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.
qGlobalOtherGrouping	Boolean	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. Default value is false.
qOtherCollapseInnerDimensions	Boolean	If set to true, it collapses the inner dimensions (if any) in the group Others. Default value is false.
qOtherSortMode	One of: OTHER_SORT_DEFAULT; sort by load order. OTHER_SORT_DESCENDING; sort by descending values. OTHER_SORT_ASCENDING; sort by ascending values.	Defines the sort order of the dimension values. Default value is OTHER_SORT_DESCENDING.
qTotalMode	One of: TOTAL_OFF TOTAL_EXPR	If set to TOTAL_EXPR, the total of the dimension values is returned. Default value is TOTAL_OFF.
qReferencedExpression	String	This parameter applies when there are several measures. Name of the measure to use for the calculation of Others for a specific dimension.

NxMeasure

A measure set in the hypercube cannot be shared with other objects.

Attribute 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.

Name	Type	Description
qLibraryId	String	Refers to a measure stored in the library. Information noteMandatory if qDef is not set. Must not be set if qDef is set.
qDef	Null or NxInlineMeasureDef.	Refers to a measure stored in the hypercube. Information noteMandatory if qLibraryId is not set. Must not be set if qLibraryId is set.
qSortBy	SortCriteria	Defines the sort criteria. This parameter is optional. The default value is sort by ascending alphabetic order.
qAttributeExpressions	Array of NxAttrExprDef.	List of attribute expressions.

Name	Type	Description
qLabel	String	Name of the measure. This parameter is optional. An empty string is returned as a default value.
qDescription	String	Description of the measure. This parameter is optional. An empty string is returned as a default value.
qTags	Array of string	Tags connected to the measure that is used for search purposes. This parameter is optional. A measure can have several tags.
qGrouping	One of: N for no grouping H for drill-down C for cyclic	Default value is N (no grouping). This parameter is optional.
qDef	String	Definition of the expression in the measure. This parameter is mandatory. Example:Sum (OrderTotal)
qNumFormat	FieldAttributes	Format of the field. This parameter is optional.
qRelative	Boolean	If set to true, percentage values are returned instead of absolute numbers. This parameter is optional. Default is false.
qBrutalSum	Boolean	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 is false. If using the Qlik Sense interface, it means that the total mode is set to Expression Total.
qAggrFunc	String	Aggregate function. For more information on the aggregate function syntax, see the section Working with Qlik Sense on the help portal. This parameter is optional. Default value is 0 (Sum of rows).
qAccumulate	Integer	One of: 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. This parameter is optional. Default is 0.
qReverseSort	Boolean	Inverts the sort criteria in the field if set to true.
qActiveExpression	Integer	Index of the active expression in a cyclic measure. The indexing starts from 0. This parameter is optional. Default value is 0.
qExpressions	Array of string	Array of expressions. This parameter is used in case of cyclic measures (qGrouping is C). List of the expressions in the cyclic group

Name	Type	Description
qSortByState	One of: -1 for sorting descending 0 for no sorting 1 for sorting ascending	Sorts the field values according to their logical state (selected, optional, alternative or excluded).
qSortByFrequency	One of: -1 for sorting ascending 0 for no sorting 1 for sorting descending	Sorts the field values by frequency (number of occurrences in the field).
qSortByNumeric	One of: -1 for sorting descending 0 for no sorting 1 for sorting ascending	Sorts the field values by numeric value.
qSortByAscii	One of: -1 for sorting descending 0 for no sorting 1 for sorting ascending	Sorts the field by alphabetical order.
qSortByLoadOrder	One of: -1 for sorting descending 0 for no sorting 1 for sorting ascending	Sorts the field values by the initial load order.
qSortByExpression	One of: -1 for sorting descending 0 for no sorting 1 for sorting ascending	Sorts the field by expression.
qExpression	"qv": "<expression>" Where <expression> is a string.	Sort by expression.

Name	Type	Description
qExpression	String	Definition of the attribute expression. Example:"Max(OrderID)"

Name

Type

Description

qExpression

String

Definition of the attribute expression.

Example:"Max(OrderID)"

NxPage

Name	Type	Description
qLeft	Integer	Position from the left. Corresponds to the first column.
qTop	Integer	Position from the top. Corresponds to the first row
qWidth	Integer	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).
qHeight	Integer	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).

Learn more

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!

Leave your feedback here