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
. - 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
-
- 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"
.
-
- dataPoint objectRequired
Data point settings.
dataPoint properties
- rangeBubbleSizes arrayRequired
Symbol size setting. Can be a value between 0.1 and 1.
- showLabels 'auto' | 'off'Required
Show labels for data points.
- symbol 'circle' | 'cross' | 'diamond' | 'line' | 'saltire' | 'square' | 'star' | 'triangle'Required
Symbol used for representation in grid.
-
- footnote string | StringExpressionRequired
Visualization footnote.
- mode 'default' | 'heatmap'Required
Chart mode.
- qHyperCubeDef objectRequired
Extends
HyperCubeDef
, see Engine API:HyperCubeDef
.qHyperCubeDef properties
- qAlwaysFullyExpanded booleanRequired
- qDimensions Array< NxDimension >Required
- qMeasures Array< NxMeasure >Required
- qMode stringRequired
Needs to be "T" in order for grid-chart to work properly
- qSuppressMissing booleanRequired
- qSuppressZero booleanRequired
-
- showDetails booleanRequired
Show visualization details toggle
- showTitles boolean
Show title for the visualization
- subtitle string | StringExpressionRequired
Visualization subtitle.
- title string | StringExpressionRequired
Visualization title.
- version stringRequired
Current version of this generic object definition
- xAxis objectRequired
X-axis settings.
xAxis properties
- axisDisplayMode 'auto' | 'custom' | 'max'Required
Set to specify axis display mode (number of items).
- dock 'near' | 'far'Required
Axis docking position
- gridLines booleanRequired
Vertical grid lines
- label 'auto' | 'horizontal' | 'tilted'Required
Label orientation
- maxVisibleItems number | ValueExpressionRequired
Only applied when axisDisplayMode is custom. Max is 55 for performance reasons.
- show 'all' | 'labels' | 'title' | 'none'Required
Labels and title
-
- yAxis objectRequired
Y-axis settings.
yAxis properties
- axisDisplayMode 'auto' | 'custom' | 'max'Required
Set to specify axis display mode (number of items).
- dock 'near' | 'far'Required
Axis docking position
- gridLines booleanRequired
Horizontal grid lines
- maxVisibleItems number | ValueExpressionRequired
Only applied when axisDisplayMode is custom. Max is 55 for performance reasons.
- show 'all' | 'labels' | 'title' | 'none'Required
Labels and title
-
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
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