Properties
- color objectRequired
Color settings. Most color options for visualizations are set in the color object in the options. You activate custom coloring by setting
"auto": false
which turns off auto-coloring. If"auto": true
, no other properties need to be defined in the color object. Note: Some of the color properties are depending on which theme is currently being used.color properties
- auto booleanRequired
Set to use automatic coloring. When
"auto": true
, color settings are based on the visualization used and the number of dimensions and measures, that is, the settings are not fixed, but are dependent on the data input. - autoMinMax booleanRequired
Set to false to define custom color range. Custom color range is only applicable when coloring is by measure (
"mode": "byMeasure"
) or by expression ("mode": "byExpression"
). When coloring is by expression,"expressionIsColor": "false"
must be set for custom color range to work. - byDimDef byDimDef
byDimDef properties
- key stringRequired
libraryId if
"type": "libraryItem"
, dimension expression if"type": "expression"
- label stringRequired
Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.
- type 'expression' | 'libraryItem'Required
-
- byMeasureDef byMeasureDef
byMeasureDef properties
- key stringRequired
libraryId if
"type": "libraryItem"
, measure expression if"type": "expression"
- label stringRequired
Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.
- type 'expression' | 'libraryItem'Required
-
- colorExpression string
Sets the color expression to be used when
"mode": "byExpression"
is defined. Expression can evaluate either to a numerical value or a color code if"expressionIsColor": true
. Supported formats are:RGB
,ARGB
andHSL
- dimensionScheme stringRequired
Color scheme when
"mode": "byDimension"
or"mode": "byMultiple"
("12"
or"100"
for most themes). - expressionIsColor booleanRequired
Set to define whether the result of the expression is a valid CSS3 color. Only applicable when
"mode": "byExpression"
. - expressionLabel stringRequired
Label to be defined on tool tips when using a coloring expression. Only used if
"expressionIsColor": false
. - formatting objectRequired
Color by measure number formatting options
formatting properties
- isCustomFormatted boolean
If true, the client formatting will be toggled off
- numFormatFromTemplate boolean
When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).
-
- measureMax ValueExpression
Set the max value for the color range. Only applicable if
"autoMinMax": false
. - measureMin ValueExpression
Set the min value for the color range. Only applicable if
"autoMinMax": false
. - measureScheme 'sg' | 'sc' | 'dg' | 'dc'Required
Color scheme when
"mode": "byMeasure"
. Can be one of:sg
: (sequential gradient) the transition between the different color groups is made using different shades of colors. High measure values have darker huessc
: (sequential classes) the transition between the different color groups is made using distinctly different colors.dg
: (diverging gradient) used when working with data that is ordered from low to high, for instance, to show the relationship between different areas on a map. Low and high values have dark colors, mid-range colors are light.dc
: (diverging classes) can be seen as two sequential classes combined, with the mid-range shared. The two extremes, high and low, are emphasized with dark colors with contrasting hues, and the mid-range critical values are emphasized with light colors.
- mode 'primary' | 'byDimension' | 'byExpression' | 'byMeasure' | 'byMultiple'Required
Sets the coloring mode for the visualization when auto-coloring has been switched off (
"auto": false
). Can be one of:primary
: a single color (by default blue) is used for all items in the chart. In visualizations that do not benefit from multiple colors (bar charts with one dimension and scatter plots), single color is the default setting.byDimension
: coloring is based upon the amount of dimension values. Details are set in the"byDimDef"
property. !Note:byDimension
can only be used in conjunction with an attribute dimension on the dimension to color by, as shown in the example below.
{ "qDef": { "qFieldDefs": [ "NetScoreName" ] }, "qAttributeDimensions": [ { "qDef": "NetScoreName", "id": "colorByAlternative", "label": "Year" } ] }
byExpression
: coloring is based on an expression, which in most cases is a color code. Details are set in the"expressionIsColor"
,"expressionLabel
" and"colorExpression"
properties.byMeasure
: coloring is based on the measure value. Details are set in the"byMeasureDef"
property.byMultiple
: can be used when more than one measure is used. By default, 12 colors are used for the dimensions. The colors are reused when there are more than 12 dimension values.
- paletteColor paletteColorRequired
The paletteColor object is used to define the color when you color by single color
("mode": "primary")
.paletteColor properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- persistent booleanRequired
Set to use persistent colors on data points between selections. Only applicable when using one dimension and when
"mode": "byDimension"
or when"mode": "byMultiple"
. - reverseScheme booleanRequired
Set to reverse the color scheme.
- singleColor number DeprecatedRequired
- useBaseColors 'off' | 'dimension' | 'measure'Required
Use colors encoded in master items. Only applicable when
"mode": "primary"
or"mode": "byMultiple"
has been defined. - useDimColVal booleanRequired
Set to true if you want to apply the colors defined for library dimensions when used. Only applicable if
'colorMode': 'byDimension'
. - useMeasureGradient booleanRequired
Set to true if you want to apply the colors defined for library measures when used. Only applicable if
"mode": "byMeasure"
.
-
- components Array< Component >Required
Styling of chart components.
- dataPoint objectRequired
Data point settings.
dataPoint properties
- auto booleanRequired
Automatically select how to present data point values.
- labelMode 'none' | 'share' | 'value'Required
Set how to present data point values. Dependent of the auto property
- labelValueMode 'arc' | 'radius'Required
Set how to present data point values. Dependent of the auto property
-
- dimensionTitle booleanRequired
Display the dimension title.
- donut objectRequired
Pie chart donut settings.
donut properties
- showAsDonut booleanRequired
Set to present the pie chart as a donut.
-
- footnote string | StringExpression
Visualization footnote.
- legend objectRequired
Legend settings.
legend properties
- dock 'auto' | 'right' | 'left' | 'bottom' | 'top'Required
Sets the legend position.
- show booleanRequired
Set to show the legend.
- showTitle booleanRequired
Show the legend title.
-
- qHyperCubeDef objectRequired
Extends
HyperCubeDef
, see Engine API:HyperCubeDef
.qHyperCubeDef properties
- qDimensions Array< DimensionProperties >Required
- qMeasures Array< MeasureProperties >Required
- qSuppressMissing booleanRequired
- qSuppressZero booleanRequired
-
- showDetails boolean
Show visualization details toggle
- showDisclaimer booleanRequired
Show visualization disclaimer toggle
- showTitles boolean
Show title for the visualization.
- subtitle string | StringExpression
Visualization subtitle.
- title string | StringExpression
Visualization title.
- tooltip objectRequired
Custom tooltip properties
tooltip properties
- auto booleanRequired
Toggle for using custom tooltip or regular tooltip
- chart MasterVisualizationChartRequired
The chart object is used to define the chart displayed by the custom tooltip.
chart properties
- Required
Object containing the information fo the visualization, such as refId in case of master visualization
object properties
- refId stringRequired
Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization
-
- Required
Object containing the styles of the chart such as 'size'
style properties
- size stringRequired
Input type as 'small' or 'medium' or 'large'
-
-
- data objectRequired
Data for the custom tooltip.
data properties
- qHyperCubeDef HyperCubeDefRequired
A hypercube definition containing measures to be displayed in the custom tooltip. Extends
HyperCubeDef
, see Engine API:HyperCubeDef
.
-
- hideBasic booleanRequired
Toggle for hiding basic information from custom tooltip
- imageComponents Array< ImageComponent >Required
The imageComponents objects are used to define the images displayed by the custom tooltip.
-
- version stringRequired
Current version of this generic object definition
Extends NxAttrDimDef
, see Engine API: NxAttrDimDef
.
Properties
- id stringRequired
One of:
colorByAlternative
: colors the chart using different dimensions (can be used together with color.mode="byDimension") orcolorByExpression
together with color.mode="byExpression".
AttributeExpressionProperties ColorAttributes | CustomTooltipAttributes
Properties
- axis AxisStylingRequired
axis properties
- title FontStylingRequired
title properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
-
-
- key stringRequired
This should be set to
"axis"
(Determines which component the settings apply to).
Properties
- title FontStylingRequired
title properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
-
Settings when coloring by dimension ("mode": "byDimension"
)
Properties
- key stringRequired
libraryId if
"type": "libraryItem"
, dimension expression if"type": "expression"
- label stringRequired
Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.
- type 'expression' | 'libraryItem'Required
Settings when coloring by measure ("mode": "byMeasure"
)
Properties
- key stringRequired
libraryId if
"type": "libraryItem"
, measure expression if"type": "expression"
- label stringRequired
Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items.
- type 'expression' | 'libraryItem'Required
Extends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
- id stringRequired
One of:
colorByAlternative
: colors the chart using different dimensions (can be used together with color.mode="byDimension") orcolorByExpression
together with color.mode="byExpression".
Extends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
- id 'customTooltipTitle' | 'customTooltipDescription' | 'customTooltipExpression'Required
Indicates how the attribute expression will be interpreted by the chart.
customTooltipTitle
: additional title displayed on the custom tooltipcustomTooltipDescription
: description displayed on the custom tooltipcustomTooltipExpression
: measures displayed on the custom tooltip
CustomTooltipAttributes
```json
"qAttributeExpressions": [{
"qExpression": "",
"qLibraryId": "",
"qAttribute": true,
"qNumFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 0,
"qFmt": "",
"qDec": "",
"qThou": "",
}
"qLabel": "custom title",
"qLabelExpression": "",
"id": "customTooltipTitle"
},
{
"qExpression": "avg(population)",
"qLibraryId": "",
"qAttribute": true,
"qNumFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 0,
"qFmt": "",
"qDec": "",
"qThou": "",
}
"qLabel": "",
"qLabelExpression": "",
"id": "customTooltipDescription"
},
{
"qExpression": "",
"qLibraryId": "zpDNMcg",
"qAttribute": true,
"qNumFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 0,
"qFmt": "",
"qDec": "",
"qThou": "",
}
"qLabel": "",
"qLabelExpression": "",
"id": "customTooltipExpression"
},
{
"qExpression": "sum(population)",
"qLibraryId": "",
"qAttribute": true,
"qNumFormat": {
"qType": "M",
"qnDec": 2,
"qUseThou": 0,
"qFmt": "$#,##0.00;-$#,##0.00",
"qDec": ".",
"qThou": ",",
}
"qLabel": "",
"qLabelExpression": "=avg(population)",
"id": "customTooltipExpression"
},
{
"qExpression": "'https://my_url/'+sum(population)",
"qLibraryId": "",
"qAttribute": true,
"qNumFormat": null,
"qLabel": "",
"qLabelExpression": "",
"cId": "generatedUniqueId",
"id": "customTooltipImages"
}]
```
Extends NxDimension
, see Engine API: NxDimension
.
Properties
- qAttributeDimensions Array< AttributeDimensionProperties >Required
- qDef InlineDimensionDefRequired
qDef properties
- othersLabel string | StringExpressionRequired
- autoSort boolean
Set to automatically sort the dimension.
- cId string
ID used by the Qlik Sense. Must be unique within the current chart.
-
Properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
Image component information structure.
Properties
- cId stringRequired
Identifier of the image component - used as a link with an attribute expression
- ref string | StringExpression | MediaLibraryRefRequired
The reference value of the image
- size stringRequired
Size as 'small','medium','large' or 'original'
- type stringRequired
Input type as 'url' or 'media library'
Extends NxInlineDimensionDef
, see Engine API: NxInlineDimensionDef
.
Properties
- othersLabel string | StringExpressionRequired
- autoSort boolean
Set to automatically sort the dimension.
- cId string
ID used by the Qlik Sense. Must be unique within the current chart.
Extends NxInlineMeasureDef
, see Engine API: NxInlineMeasureDef
.
Properties
- isCustomFormatted booleanRequired
Set to true to toggle off the default client formatting.
- numFormatFromTemplate booleanRequired
When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).
- othersLabel string | StringExpressionRequired
- autoSort boolean
Set to automatically sort the measure.
- cId string
ID used by the Qlik Sense. Must be unique within the current chart.
Properties
- key stringRequired
This should be set to
"label"
(Determines which component the settings apply to). - label LabelStylingRequired
label properties
- name LabelNameStylingRequired
Dimension value labels
name properties
- name FontStylingRequired
name properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
-
-
- value LabelValueStylingRequired
Measure value labels and share.
value properties
- value FontStylingRequired
-
-
Properties
- name FontStylingRequired
name properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
-
Properties
- name LabelNameStylingRequired
Dimension value labels
name properties
- name FontStylingRequired
name properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
-
-
- value LabelValueStylingRequired
Measure value labels and share.
value properties
- value FontStylingRequired
-
Properties
- value FontStylingRequired
value properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
-
Properties
- key stringRequired
This should be set to
"legend"
(Determines which component the settings apply to). - legend LegendStylingRequired
legend properties
- label LabelNameStyleRequired
- title FontStylingRequired
title properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
-
-
Properties
- label LabelNameStyleRequired
- title FontStylingRequired
title properties
- color paletteColorRequired
color properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- fontFamily stringRequired
- fontSize stringRequired
-
Chart component information structure.
Properties
- Required
Object containing the information fo the visualization, such as refId in case of master visualization
object properties
- refId stringRequired
Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization
-
- Required
Object containing the styles of the chart such as 'size'
style properties
- size stringRequired
Input type as 'small' or 'medium' or 'large'
-
Chart component information structure.
Properties
- refId stringRequired
Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization
Chart component information structure.
Properties
- size stringRequired
Input type as 'small' or 'medium' or 'large'
Extends NxMeasure
, see Engine API: NxMeasure
.
Properties
- qAttributeExpressions Array< AttributeExpressionProperties >Required
- qDef InlineMeasureDefRequired
qDef properties
- isCustomFormatted booleanRequired
Set to true to toggle off the default client formatting.
- numFormatFromTemplate booleanRequired
When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).
- othersLabel string | StringExpressionRequired
- autoSort boolean
Set to automatically sort the measure.
- cId string
ID used by the Qlik Sense. Must be unique within the current chart.
-
Media Library Reference structure.
Properties
- qStaticContentUrlDef objectRequired
Media library structure
Color information structure. Holds the actual color and index in palette.
Properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
Media Library structure that will be evaluated by the engine.
Properties
- qUrl stringRequired
Value of media library image
Properties
- key stringRequired
This should be set to
"slices"
(Determines which component the settings apply to). - style SlicesStylingRequired
style properties
- cornerRadius numberRequired
A number between 0 and 40.
- innerRadius numberRequired
A number between 0.05 and 0.75. Only applicable for "donut" representation.
- strokeColor paletteColorRequired
index: -1, color: '#ffffff' }"
strokeColor properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- strokeWidth 'none' | 'small' | 'medium' | 'large'Required
Set to specify stroke width.
-
Properties
- cornerRadius numberRequired
A number between 0 and 40.
- innerRadius numberRequired
A number between 0.05 and 0.75. Only applicable for "donut" representation.
- strokeColor paletteColorRequired
index: -1, color: '#ffffff' }"
strokeColor properties
- color stringRequired
Color as hex string (mandatory if index: -1)
- index numberRequired
Index in palette
-
- strokeWidth 'none' | 'small' | 'medium' | 'large'Required
Set to specify stroke width.