Nebula Scatter plot

Scatter plot generic object definition

Download specification

Properties

color object
Required
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.
Show color properties
- auto boolean
  Required
  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.
  default = true
- autoMinMax boolean
  Required
  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.
  default = true
- byDimDef byDimDef
  default = "undefined"
  
  Show byDimDef properties
  
  key string
  Required
  libraryId if "type": "libraryItem", dimension expression if "type": "expression"
  
  label string
  Required
  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
  default = "undefined"
  
  Show byMeasureDef properties
  
  key string
  Required
  libraryId if "type": "libraryItem", measure expression if "type": "expression"
  
  label string
  Required
  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 and HSL
  default = "undefined"
- dimensionScheme '12' | '100'
  Required
  Color scheme when "mode": "byDimension" or "mode": "byMultiple" ("12" or "100" for most themes).
  default = "12"
- expressionIsColor boolean
  Required
  Set to define whether the result of the expression is a valid CSS3 color. Only applicable when "mode": "byExpression".
  default = true
- expressionLabel string
  Required
  Label to be defined on tool tips when using a coloring expression. Only used if 'expressionIsColor': false.
  default = ""
- formatting object
  Required
  Color by measure number formatting options
  
  Show formatting properties
  
  numFormatFromTemplate boolean
  When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).
  default = true
- measureMax number | ValueExpression
  Required
  Set the max value for the color range. Only applicable if "autoMinMax": false.
  default = 10
- measureMin number | ValueExpression
  Required
  Set the min value for the color range. Only applicable if "autoMinMax": false.
  default = 0
- 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 hues
  
  sc: (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.
  
  default = "sg"
- 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.
  
  default = "primary"
- paletteColor paletteColor
  Required
  The paletteColor object is used to define the color when you color by single color ("mode": "primary").
  default = "{ index: 6 }"
  
  Show paletteColor properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
- persistent boolean
  Required
  Set to use persistent colors on data points between selections. Only applicable when using one dimension and when "mode": "byDimension" or when "mode": "byMultiple".
  default = false
- reverseScheme boolean
  Required
  Set to reverse the color scheme.
  default = false
- useBaseColors 'off' | 'dimension' | 'measure'
  Required
  Use colors encoded in master items. Only applicable when "mode": "primary" or "mode": "byMultiple" has been defined.
  default = "off"
- useDimColVal boolean
  Required
  Set to true if you want to apply the colors defined for library dimensions when used. Only applicable if 'colorMode': 'byDimension'.
  default = true
- useMeasureGradient true
  Required
  Set to true if you want to apply the colors defined for library measures when used. Only applicable if "mode": "byMeasure".
components Array< scatterPlotStyle >
Required
Styling of chart components.
dataPoint object
Required
Data points settings.
Show dataPoint properties
- bubbleSizes number
  Required
  Set bubble size when there is no measure for size.
  default = 5
- compressionResolution number
  Required
  Resolution settings for compressed data.
  default = 5
- rangeBubbleSizes array
  Required
  Bubble sizes. Represented as an array of two integers where the first index is the from-size and the second the to-size. From-size needs to be smaller. Only applicable when there is a third neasure.
  default = "5"
disableNavMenu boolean
Required
Set to enable or disable navigation menu.
default = false
footnote string | StringExpression
Visualization footnote.
default = ""
gridLine object
Required
Grid lines settings.
Show gridLine properties
- auto boolean
  Required
  Automatic grid line spacing.
  default = true
- spacing 0 | 1 | 2 | 3
  Required
  Grid line spacing. Used only when auto is set to false.
  default = 2
labels object
Required
Label mode settings.
default = "{\"mode\":1}"
Show labels properties
- mode 0 | 1 | 2
  Required
  Show labels. 1 for auto, 2 for show all and 0 for hiding labels.
  default = 1
legend object
Required
Legend settings.
Show legend properties
- dock 'auto' | 'right' | 'left' | 'bottom' | 'top'
  Required
  Sets the legend position.
  default = "auto"
- show boolean
  Required
  Set to show the legend.
  default = true
- showTitle boolean
  Required
  Show the legend title.
  default = true
maxVisibleBubbles number
Required
Set the maximum number of visible bubbles for the chart. Max is 50000 and min is 1000.
default = 2500
navigation boolean
Required
Show navigation UI.
default = false
qHyperCubeDef object
Required
Extends HyperCubeDef, see Engine API: HyperCubeDef.
Show qHyperCubeDef properties
- qDimensions Array< DimensionProperties >
  Required
- qMeasures Array< MeasureProperties >
  Required
- qSuppressMissing boolean
  Required
  default = true
refLine object
Required
Reference lines settings
Show refLine properties
- refLinesX Array< refLine >
  Required
  Array of x-axis reference line definitions
- refLinesY Array< refLine >
  Required
  Array of y-axis reference line definitions
showDetails boolean
Show visualization details toggle
default = false
showDisclaimer boolean
Required
Show visualization disclaimer toggle
default = true
showTitles boolean
Show title for the visualization.
default = true
subtitle string | StringExpression
Visualization subtitle.
default = ""
title string | StringExpression
Visualization title.
default = ""
tooltip object
Required
Custom tooltip properties
Show tooltip properties
- auto boolean
  Required
  Toggle for using custom tooltip or regular tooltip
  default = true
- chart MasterVisualizationChart
  Required
  The chart object is used to define the chart displayed by the custom tooltip.
  default = "undefined"
  
  Show chart properties
  
  object MasterVisualizationChartObject
  Required
  Object containing the information fo the visualization, such as refId in case of master visualization
  
  Show object properties
  
  refId string
  Required
  Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization
  
  style MasterVisualizationChartStyle
  Required
  Object containing the styles of the chart such as 'size'
  
  Show style properties
  
  size string
  Required
  Input type as 'small' or 'medium' or 'large'
- description string | StringExpression
  Custom tooltip description.
  default = ""
- hideBasic boolean
  Required
  Toggle for hiding basic information from custom tooltip
  default = false
- imageComponents Array< ImageComponent >
  Required
  The imageComponents objects are used to define the images displayed by the custom tooltip.
  default = "undefined"
- title string | StringExpression
  Custom tooltip title.
  default = ""
trendLines Array< trendLine >
Required
Array of trend lines
version string
Required
Current version of this generic object definition
xAxis object
Required
X-axis settings.
Show xAxis properties
- autoMinMax boolean
  Required
  Automatic max/min
  default = true
- dock 'near' | 'far'
  Required
  Axis docking position
  default = "near"
- max number | ValueExpression
  Required
  Axis max value. "autoMinMax" must be set to false and "minMax" must be set to "max" or "minMax" to use this property
  default = 10
- min number | ValueExpression
  Required
  Axis min value. "autoMinMax" must be set to false and "minMax" must be set to "min" or "minMax" to use this property
  default = 0
- minMax 'min' | 'max' | 'minMax'
  Required
  Set custom max/min
  default = "min"
- show 'all' | 'labels' | 'title' | 'none'
  Required
  Labels and title
  default = "all"
- spacing number
  Required
  Axis scale
  default = 1
yAxis object
Required
Y-axis settings.
Show yAxis properties
- autoMinMax boolean
  Required
  Automatic max/min
  default = true
- dock 'near' | 'far'
  Required
  Axis docking position
  default = "near"
- max number | ValueExpression
  Required
  Axis max value. "autoMinMax" must be set to false and "minMax" must be set to "max" or "minMax" to use this property
  default = 10
- min number | ValueExpression
  Required
  Axis min value. "autoMinMax" must be set to false and "minMax" must be set to "min" or "minMax" to use this property
  default = 0
- minMax 'min' | 'max' | 'minMax'
  Required
  Set custom max/min
  default = "min"
- show 'all' | 'labels' | 'title' | 'none'
  Required
  Labels and title
  default = "all"
- spacing number
  Required
  Axis scale
  default = 1

extends NxAttrDimDef

Extends NxAttrDimDef, see Engine API: NxAttrDimDef.

Properties

id string
Required
One of: colorByAlternative: colors the chart using different dimensions (can be used together with color.mode="byDimension") or colorByExpression together with color.mode="byExpression".

Properties

label labelNameStyle
Required
Show label properties
- name fontStyle
  Required
title fontStyle
Required
Show title properties
- color paletteColor
  Required
  
  Show color properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
- fontFamily string
  Required
- fontSize string
  Required

Settings when coloring by dimension ("mode": "byDimension")

Properties

key string
Required
libraryId if "type": "libraryItem", dimension expression if "type": "expression"
label string
Required
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 string
Required
libraryId if "type": "libraryItem", measure expression if "type": "expression"
label string
Required
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

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id string
Required
One of: colorByAlternative: colors the chart using different dimensions (can be used together with color.mode="byDimension") or colorByExpression together with color.mode="byExpression".

extends NxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id 'customTooltipTitle' | 'customTooltipDescription' | 'customTooltipExpression' | 'customTooltipImages'
Required
Indicates how the attribute expression will be interpreted by the chart. customTooltipTitle: additional title displayed on the custom tooltip customTooltipDescription: description displayed on the custom tooltip customTooltipExpression: 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

Extends NxDimension, see Engine API: NxDimension.

Properties

qAttributeDimensions Array< AttributeDimensionProperties >
Required
qDef InlineDimensionDef
Required
Show qDef properties
- othersLabel string | StringExpression
  Required
- 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 paletteColor
Required
Show color properties
- color string
  Required
  Color as hex string (mandatory if index: -1)
- index number
  Required
  Index in palette
fontFamily string
Required
fontSize string
Required

Image component information structure.

Properties

cId string
Required
Identifier of the image component - used as a link with an attribute expression
ref string | StringExpression | MediaLibraryRef
Required
The reference value of the image
size string
Required
Size as 'small','medium','large' or 'original'
type string
Required
Input type as 'url' or 'media library'

extends NxInlineDimensionDef

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Properties

othersLabel string | StringExpression
Required
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

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

isCustomFormatted boolean
Required
Set to true to toggle off the default client formatting.
numFormatFromTemplate boolean
Required
When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).
default = true
othersLabel string | StringExpression
Required
autoSort boolean
Set to automatically sort the measure.
cId string
ID used by the Qlik Sense. Must be unique within the current chart.

Properties

name fontStyle
Required
Show name properties
- color paletteColor
  Required
  
  Show color properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
- fontFamily string
  Required
- fontSize string
  Required

Properties

value fontStyle
Required
Show value properties
- color paletteColor
  Required
  
  Show color properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
- fontFamily string
  Required
- fontSize string
  Required

Properties

label fontStyle
Required
Show label properties
- color paletteColor
  Required
  
  Show color properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
- fontFamily string
  Required
- fontSize string
  Required
title fontStyle
Required

Chart component information structure.

Properties

object MasterVisualizationChartObject
Required
Object containing the information fo the visualization, such as refId in case of master visualization
Show object properties
- refId string
  Required
  Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization
style MasterVisualizationChartStyle
Required
Object containing the styles of the chart such as 'size'
Show style properties
- size string
  Required
  Input type as 'small' or 'medium' or 'large'

Chart component information structure.

Properties

refId string
Required
Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization

Chart component information structure.

Properties

size string
Required
Input type as 'small' or 'medium' or 'large'

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

qAttributeExpressions Array< AttributeExpressionProperties >
Required
qDef InlineMeasureDef
Required
Show qDef properties
- isCustomFormatted boolean
  Required
  Set to true to toggle off the default client formatting.
- numFormatFromTemplate boolean
  Required
  When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).
  default = true
- othersLabel string | StringExpression
  Required
- 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 object
Required
Media library structure

Color information structure. Holds the actual color and index in palette.

Properties

color string
Required
Color as hex string (mandatory if index: -1)
index number
Required
Index in palette

Properties

label labelNameStyle
Required
Show label properties
- name fontStyle
  Required
  
  Show name properties
  
  color paletteColor
  Required
  
  Show color properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
  
  fontFamily string
  Required
  
  fontSize string
  Required

Properties

label string
Required
Reference line label.
paletteColor paletteColor
Required
Show paletteColor properties
- color string
  Required
  Color as hex string (mandatory if index: -1)
- index number
  Required
  Index in palette
refLineExpr object
Required
Show refLineExpr properties
- value number | ValueExpression
  Required
- label string | StringExpression
show boolean | ValueExpression
Required
Set to true to display this reference line.
default = true
coloredBackground boolean
Set to true to fill the label and/or value of this reference line with this color
default = false
showLabel boolean
Set to true to show the label of this reference line.
default = true
showValue boolean
Set to true to show the value of this reference line.
default = true
style refLineStyle
Styling settings for reference line
Show style properties
- lineThickness number
  Set the thickness for this reference line.
  default = 2
- lineType string
  Set the dash type for this reference line.
  default = ""

Styling settings for reference line

Properties

lineThickness number
Set the thickness for this reference line.
default = 2
lineType string
Set the dash type for this reference line.
default = ""

Properties

axis axisStyle
Required
Show axis properties
- label labelNameStyle
  Required
  
  Show label properties
  
  name fontStyle
  Required
- title fontStyle
  Required
  
  Show title properties
  
  color paletteColor
  Required
  
  Show color properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
  
  fontFamily string
  Required
  
  fontSize string
  Required
key string
Required
Determines which component the settings apply to.
label labelStyle
Required
Show label properties
- value fontStyle
  Required
legendStyle legendStyle
Required
Show legendStyle properties
- label fontStyle
  Required
- title fontStyle
  Required
referenceLine referenceLineStyle
Required
Show referenceLine properties
- label labelNameStyle
  Required

Properties

flipXY boolean
Required
Set to true if the first measure should be the dependent variable
default = false
label string
Required
Trend line label
qMultiDimMode string
Required
Not applicable for scatter plot since it has only one dimension
default = "Sum"
qType string
Required
Trend line type, for example LINEAR or EXPONENTIAL
qXColIx number
Required
The column in the hypercube to be used as x axis. Related to flipXY.
style object
Required
Show style properties
- autoColor boolean
  Required
  default = true
- dashed boolean
  Required
  default = true
- lineDash string
  Required
  Represents the lengths of the dashes and the breaks
- paletteColor paletteColor
  Required
  
  Show paletteColor properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette

Nebula Scatter plot

properties namespace

Properties

AttributeDimensionProperties object

Properties

AttributeExpressionProperties ColorAttributes | CustomTooltipAttributes

axisStyle object

Properties

byDimDef object

Properties

byMeasureDef object

Properties

ColorAttributes object

Properties

CustomTooltipAttributes object

Properties

CustomTooltipAttributes

DimensionProperties object

Properties

fontStyle object

Properties

ImageComponent object

Properties

InlineDimensionDef object

Properties

InlineMeasureDef object

Properties

labelNameStyle object

Properties

labelStyle object

Properties

legendStyle object

Properties

MasterVisualizationChart object

Properties

MasterVisualizationChartObject object

Properties

MasterVisualizationChartStyle object

Properties

MeasureProperties object

Properties

MediaLibraryRef object

Properties

paletteColor object

Properties

referenceLineStyle object

Properties

refLine object

Properties

refLineStyle object

Properties

scatterPlotStyle object

Properties

trendLine object

Properties