Distribution plot properties

These are the properties used by Qlik Sense distribution plots.

Properties

showTitles

Type: Boolean

Show title for the visualization.

Default: true.

showDetails

Type: Boolean

Sets if visualization details should be shown.

Default: false

title

Type: String | qStringExpression

Visualization title shown if "showTitles": true.

subtitle

Type: String | qStringExpression

Visualization subtitle shown if "showTitles": true.

footnote

Type: String | qStringExpression

Visualization footnote shown if "showTitles": true.

disableNavMenu

Type: Boolean

Disables the hover menu in the visualization.

Default: false

showDisclaimer

Type: Boolean

Set to false to hide visualization disclaimers that appear at the bottom of the chart, such as limited data or the chart has negative values.

Default: true

qHyperCubeDef

Type: Object

The hypercube definition used by most visualizations.

A subset of the properties available in the qHyperCubeDef is presented here. For complete documentation of all available properties, see Engine API: HyperCubeDef.

Properties

qDimension

Type: Array

Description: Extends NxDimension, see Engine API: NxDimension.

Additional properties

qDef

Type: Object

Description: Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

qDef properties
Name	Type	Description
autoSort	Boolean	Set to automatically sort the dimension. Default: true
cId	String	ID used by the client. Must be unique within the current chart.
othersLabel	StringExpressionContainer	String expression container.

qAttributeDimensions

Type: Array

Description: Extends NxAttrDimDef, see Engine API: NxAttrDimDef.

id

Type: String

One of:
- colorByAlternative: colors the chart using different dimensions. Can be used together with color.mode="byDimension" for attribute dimensions.
- colorByExpression: used together with color.mode="byExpression".

qMeasures

Type: Array

Description: Extends NxMeasure, see Engine API: NxMeasure.

Additional properties

qDef

Type: Object

Description: Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

qDef Properties
Name	Type	Description
autoSort	Boolean	Set to automatically sort the measure. Default: true
cId	String	ID used by the client. Must be unique within the current chart.
numFormatFromTemplate	Boolean	When enabled, the number format to use can be selected from multiple predefined formats based on the desired type: number or date. Default: true
isCustomFormatted	Boolean	Set to true to toggle off the default client formatting.
othersLabel	StringExpressionContainer	String expression container.

qAttributeExpressions

Type: Array

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

id

Type: String

One of:
- colorByAlternative: colors the chart using different dimensions. Can be used together with color.mode="byDimension" for attribute dimensions.
- colorByExpression: used together with color.mode="byExpression".

qLayoutExclude

Type: Object

customErrorMessage

Type: Object

Set to define custom error messages.

calcCondition

Type: String

Description: Deprecated. Use qCalcCondition.qMsg instead. Set to customize the calculation condition unfilled message.

dimensionAxis

Type: Object

Dimension axis settings.

dimensionAxis properties
Name	Type	Description
show	String	Defines if titles and labels should be visible. Can be one of: all labels title none Default: all
label	String	Defines the label orientation. Can be one of: auto horizontal tilted Default: auto
dock	String	Axis docking position. Can be: near far Default: near

measureAxis

Type: Object

Measure axis settings.

measureAxis properties
Name	Type	Description
show	String	Set to display the labels and titles. Can be one of: all labels title none Default: all
dock	String	Sets the axis docking position. Can be one of: near far Default: near
spacing	Number	Set the axis scale: Default: 1
autoMinMax	Boolean	Set to use automatic min/max for measure color. Default: true
minMax	String	Set custom max/min. Can be one of: min max minMax Default: min
min	ValueExpressionContainer	Set the min value for the range.
max	ValueExpressionContainer	Set the max value for the range.

gridLine

Type: Object

Grid line settings.

gridLine properties
Name	Type	Description
auto	Boolean	Set to use automatic grid line spacing. Default: true
spacing	Integer	Grid line spacing. Used only when "auto": false. One of: 0: no lines 1: wide 2: medium 3: narrow Default: 2

orientation

Type: String

Orientation settings. Can be:

horizontal
vertical

If vertical, the dimension axis can only be docked on bottom or top and measure axis on left or right.

Default: vertical

refLine

Type: Object

Reference line settings.

refLines

Type: Array

refLines properties
Name	Type	Description
show	Boolean	Set to true to display this reference line. Default: true
label	String	Reference line label.
color	Integer	Deprecated. Use paletteColor instead. Color. Default: 3
paletteColor	Object	Description: Color information structure. Holds the actual color and index in palette. color: Type: String Description: Color as hex string (mandatory if index: -1) index: Type: Integer Description: Index in palette. If a custom color, not in the palette, is being used, set index to -1.

presentation

Type: Object

Presentation settings for the distribution plot.

visibleComponents

Type: String

Sets which components of the plot that should be visible. Chose between points and box, only points, or only box. Can be:

points_box
points
box

Default: points_box

dataPoint

Type: Object

dataPoint properties
Name	Type	Description
bubbleScales	Integer	Size parameter for points. Minimum value: 20, Maximum value: 100. Default: 100
displacement	String	Controls displacement of data points. Can be one of: none jitter Default: none

color

Type: Object

Color settings for the distribution plot.

box

Type: Object

Description: Color information structure. Holds actual color and index in palette.

box properties
Name	Type	Description
index	Integer	Index in palette. Default: 6
color	String	Color as HEX string. Default: #E6E6E6

point

Type: Object

Description: Color information structure. Holds actual color and index in palette.

point properties
Name	Type	Description
color	String	Color as HEX string. Default: #4477aa
auto	Boolean	Use automatic coloring. Default: true
mode	String	Sets the coloring mode for the chart. Can be one of: primary byDimension byExpression Default: primary byExpression can only be used in conjunction with an attribute expression on the first measure: qHyperCubeDef.qMeasures.0.qAttributeExpressions.0.qExpression
paletteColor	Object	Color information structure. Holds the actual color and index in palette. color: Type: String Description: Color as hex string (mandatory if index: -1) index: Type: Integer Description: Index in palette. If a custom color, not in the palette, is being used, set index to -1.
persistent	Boolean	Set to use persistent colors on data points between selections.
useDimColVal	Boolean	Set to apply colors from the used library dimension. Only used together with "colorMode": "byDimension". Default: true
dimensionScheme	String	Dimension color scheme. Can be one of: 12 100 Default: 12
useBaseColors	String	Set to use colors encoded in master items. Can be one of: off dimension Default: off

sorting

Type: Object

Sorting properties that can be set on the outer dimension.

sorting properties
Name	Type	Description
autoSort	Boolean	Set to sort automatically. Default: true
elementId	String	Sorting preset. Can be one of: distplot-exp-min distplot-exp-max Default: distplot-exp-min
expression	ValueExpressionContainer	Value expression container.
sortCriteria	Object	Sorting criteria. Can be one of the following Number values: sortByAscii sortByExpression sortByNumeric

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