Nebula Line chart

Line chart 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
  
  isCustomFormatted boolean
  If true, the client formatting will be toggled off
  default = false
  
  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 ValueExpression
  Set the max value for the color range. Only applicable if "autoMinMax": false.
  default = "undefined"
- measureMin ValueExpression
  Set the min value for the color range. Only applicable if "autoMinMax": false.
  default = "undefined"
- 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
- singleColor number Deprecated
  Required
- 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 boolean
  Required
  Set to true if you want to apply the colors defined for library measures when used. Only applicable if "mode": "byMeasure".
  default = true
components Array< Component >
Required
Styling of chart components.
dataPoint object
Required
Data point settings.
Show dataPoint properties
- show boolean
  Required
  Show data points.
  default = false
- showLabels boolean
  Required
  Show labels on data points.
  default = false
dimensionAxis object
Required
Dimension axis settings.
Show dimensionAxis properties
- axisDisplayMode 'auto' | 'custom' | 'max'
  Required
  Set to specify axis display mode (number of axis values).
  default = "auto"
- continuousAuto boolean
  Required
  Continuous setting used for toggling between auto and custom setting
  default = true
- dock 'near' | 'far'
  Required
  Axis docking position
  default = "near"
- label 'auto' | 'horizontal' | 'tilted'
  Required
  Label orientation
  default = "auto"
- maxVisibleItems number | ValueExpression
  Required
  Only visible when axisDisplayMode is custom. Max = 10000 / (numDims+numMeasures)
  default = 10
- show 'all' | 'labels' | 'title' | 'none'
  Required
  Labels and title
  default = "all"
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
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
lineType 'line' | 'area'
Required
Type of line chart.
default = "line"
measureAxis object
Required
Measure axis settings.
Show measureAxis properties
- autoMinMax boolean
  Required
  Automatic max/min
  default = true
- dock 'near' | 'far'
  Required
  Axis docking position
  default = "near"
- logarithmic boolean
  Required
  Logarithmic scale
  default = false
- 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
nullMode 'gap' | 'connect' | 'zero'
Null value presentation
default = "gap"
orientation 'vertical' | 'horizontal'
Required
Orientation setting. If horizontal, the dimension axis can only be docked on bottom or top and measure axis on left or right.
default = "horizontal"
preferContinuousAxis boolean
Required
Chart axis setting to control preference of scale on a dimensional axis. If true, the scale along the dimensional axis will be continuous if the data supports it, discrete otherwise.
default = true
qHyperCubeDef object
Required
Extends HyperCubeDef, see Engine API: HyperCubeDef.
Show qHyperCubeDef properties
- qAlwaysFullyExpanded boolean
  Required
  default = true
- qDimensions Array< DimensionProperties >
  Required
- qMeasures Array< MeasureProperties >
  Required
- qSuppressMissing boolean
  Required
  default = true
- qSuppressZero boolean
  Required
  default = false
refLine object
Required
Reference lines settings
Show refLine properties
- dimRefLines Array< dimRefLine >
  Required
  Array of dimension based reference line definitions
- refLines Array< refLine >
  Required
  Array of measure based reference line definitions
scrollbar 'bar' | 'miniChart' | 'none'
Required
Sets the style of the scroll bar
default = "miniChart"
scrollStartPos number
Required
Scroll Alignment. If 0, then the scrollbar will start at the left/top of the chart, if 1 it starts at the right/bottom of the chart. Generally decides if the scroll starts at the beginning or end of the data
default = 0
separateStacking boolean
Required
Stack positive and negative values separately. Dependent of lineType property.
default = true
showDetails boolean
Show visualization details toggle
default = true
showDisclaimer boolean
Required
Show visualization disclaimer toggle
default = true
showMiniChartForContinuousAxis boolean
Required
Chart axis setting to turn on/off the mini chart for continuous axis.
default = true
showTitles boolean
Show title for the visualization.
default = true
stackedArea boolean
Required
Stack areas. Dependent of lineType property.
default = false
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 = ""
version string
Required
Current version of this generic object definition

It allows you to accumulate values of your measure over one or two dimensions.

Properties

fullAccumulation boolean
Required
Select whether the accumulation will happen on the Full range or Custom range.
showExcludedValues boolean
Required
Shows the excluded values (values not in the current selection) in the accumulation.
type string
Required
This should be set to "accumulation".
accumulationDimension: number
Only applicable when there are two dimensions. Selects the dimension on which the accumulation will take place. If the accumulation is made across multiple dimensions, this will be the first dimension.
crossAllDimensions boolean
Only applicable when there are two dimensions. Continues accumulation across both dimensions.
disabled boolean
steps number
Only applicable when fullAccumulation is set to false. The number of steps in the dimensions which form an accumulation range. Only zero and positive integers are accepted. Note: Sorting order of dimension values (or step order) is important and affects results.

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

axis AxisStyling
Required
Show axis properties
- label LabelNameStyling
  Required
  
  Show label properties
  
  name FontStyling
  Required
- title FontStyling
  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
This should be set to "axis" (Determines which component the settings apply to).

Properties

label LabelNameStyling
Required
Show label properties
- name FontStyling
  Required
title FontStyling
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'
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"
}]
```

Properties

showExcludedValues boolean
Required
Shows the excluded values (values not in the current selection) in the difference.
type string
Required
This should be set to "difference".
accumulationDimension: number
Only applicable when there are two dimensions. Selects the dimension on which the difference will take place. If the difference is made across multiple dimensions, this will be the first dimension.
crossAllDimensions boolean
Only applicable when there are two dimensions. Continues the difference across both dimensions.
disabled boolean

Properties

steps number
Required
Number of forecast steps
default = 3
stepSize number
Required
default = "days"
stepSizeMultiplier number
Required
default = 1

extends NxDimension

Extends NxDimension, see Engine API: NxDimension.

Properties

qAttributeDimensions Array< AttributeDimensionProperties >
Required
qDef InlineDimensionDef
Required
Show qDef properties
- forecast DimensionForecast
  Required
  
  Show forecast properties
  
  steps number
  Required
  Number of forecast steps
  default = 3
  
  stepSize number
  Required
  default = "days"
  
  stepSizeMultiplier number
  Required
  default = 1
- 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

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
- stringValue string | StringExpression
  Required
show boolean | ValueExpression
Required
Set to true to display this reference line.
default = true
align 'start' | 'center' | 'end'
Set alignment for this reference line
default = "center"
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 = ""

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

extends NxAttrExprDef

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Properties

id 'forecast' | 'forecast_lower' | 'forecast_lower'
Required
Indicates how the attribute expression will be interpreted by the chart. forecast: forecast line forecast_lower: lower edge of forecast confidence interval forecast_upper: upper edge of forecast confidence interval

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

forecast DimensionForecast
Required
Show forecast properties
- steps number
  Required
  Number of forecast steps
  default = 3
- stepSize number
  Required
  default = "days"
- stepSizeMultiplier number
  Required
  default = 1
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

forecast MeasureForecast
Required
Show forecast properties
- confidence number
  Required
  Only relevant when method is 'SSA' and showConfidence is true. should be between 0 and 1 (exclusive)
  default = 0.95
- enabled boolean
  Required
  default = false
- lineCurve 'linear' | 'monotone'
  Required
  default = "linear"
- lineThickness number
  Required
  Set to specify line thickness. Can be set from 1 to 5.
  default = 1
- lineType 'solid' | 'dashed'
  Required
  default = "dashed"
- method 'ssa_forecast' | 'ols_forecast'
  Required
  Forecast method
  default = "ssa_forecast"
- paletteColor paletteColor
  Required
  
  Show paletteColor properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
- showConfidence boolean
  Required
  Only used when method is 'SSA'
  default = true
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.
modifiers Array< Modifier >
Set to apply a modifier to a measure.
style LineStyling
Can be used to change the line thickness, line type, and line curve for one of the lines. These style settings will override the components styling settings.
Show style properties
- dataPointSize number
  Required
  Set to specify the size of the data point.
  default = 6
- lineCurve 'linear' | 'monotone'
  Required
  default = "linear"
- lineThickness number
  Required
  Set to specify line thickness. Can be set from 1 to 5.
  default = 1
- lineType 'solid' | 'dashed'
  Required
  default = "solid"

Properties

key string
Required
This should be set to "label" (Determines which component the settings apply to).
label LabelValueStyling
Required
Show label properties
- value FontStyling
  Required
  Data points labels
  
  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

name FontStyling
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 FontStyling
Required
Data points labels
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

key string
Required
This should be set to "legend" (Determines which component the settings apply to).
legend LegendStyling
Required
Show legend properties
- label LabelNameStyling
  Required
  
  Show label properties
  
  name FontStyling
  Required
- title FontStyling
  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

Properties

label LabelNameStyling
Required
Show label properties
- name FontStyling
  Required
title FontStyling
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

Properties

key string
Required
This should be set to "line" (Determines which component the settings apply to).
style LineStyling
Required
Show style properties
- dataPointSize number
  Required
  Set to specify the size of the data point.
  default = 6
- lineCurve 'linear' | 'monotone'
  Required
  default = "linear"
- lineThickness number
  Required
  Set to specify line thickness. Can be set from 1 to 5.
  default = 1
- lineType 'solid' | 'dashed'
  Required
  default = "solid"

Properties

dataPointSize number
Required
Set to specify the size of the data point.
default = 6
lineCurve 'linear' | 'monotone'
Required
default = "linear"
lineThickness number
Required
Set to specify line thickness. Can be set from 1 to 5.
default = 1
lineType 'solid' | 'dashed'
Required
default = "solid"

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'

Properties

confidence number
Required
Only relevant when method is 'SSA' and showConfidence is true. should be between 0 and 1 (exclusive)
default = 0.95
enabled boolean
Required
default = false
lineCurve 'linear' | 'monotone'
Required
default = "linear"
lineThickness number
Required
Set to specify line thickness. Can be set from 1 to 5.
default = 1
lineType 'solid' | 'dashed'
Required
default = "dashed"
method 'ssa_forecast' | 'ols_forecast'
Required
Forecast method
default = "ssa_forecast"
paletteColor paletteColor
Required
Show paletteColor properties
- color string
  Required
  Color as hex string (mandatory if index: -1)
- index number
  Required
  Index in palette
showConfidence boolean
Required
Only used when method is 'SSA'
default = true

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

qAttributeExpressions Array< AttributeExpressionProperties >
Required
qDef InlineMeasureDef
Required
Show qDef properties
- forecast MeasureForecast
  Required
  
  Show forecast properties
  
  confidence number
  Required
  Only relevant when method is 'SSA' and showConfidence is true. should be between 0 and 1 (exclusive)
  default = 0.95
  
  enabled boolean
  Required
  default = false
  
  lineCurve 'linear' | 'monotone'
  Required
  default = "linear"
  
  lineThickness number
  Required
  Set to specify line thickness. Can be set from 1 to 5.
  default = 1
  
  lineType 'solid' | 'dashed'
  Required
  default = "dashed"
  
  method 'ssa_forecast' | 'ols_forecast'
  Required
  Forecast method
  default = "ssa_forecast"
  
  paletteColor paletteColor
  Required
  
  Show paletteColor properties
  
  color string
  Required
  Color as hex string (mandatory if index: -1)
  
  index number
  Required
  Index in palette
  
  showConfidence boolean
  Required
  Only used when method is 'SSA'
  default = true
- 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.
- modifiers Array< Modifier >
  Set to apply a modifier to a measure.
- style LineStyling
  Can be used to change the line thickness, line type, and line curve for one of the lines. These style settings will override the components styling settings.
  
  Show style properties
  
  dataPointSize number
  Required
  Set to specify the size of the data point.
  default = 6
  
  lineCurve 'linear' | 'monotone'
  Required
  default = "linear"
  
  lineThickness number
  Required
  Set to specify line thickness. Can be set from 1 to 5.
  default = 1
  
  lineType 'solid' | 'dashed'
  Required
  default = "solid"

Media Library Reference structure.

Properties

qStaticContentUrlDef object
Required
Media library structure

Properties

fullRange boolean
Required
Select whether the moving average will happen on the Full range or Custom range.
nullSuppression boolean
Required
Choose to have null values calculated by the moving average modifier.
showExcludedValues boolean
Required
Shows the excluded values (values not in the current selection) in the moving average.
type string
Required
This should be set to "movingAverage".
accumulationDimension: number
Only applicable when there are two dimensions. Selects the dimension on which the moving average will take place. If the moving average is made across multiple dimensions, this will be the first dimension.
crossAllDimensions boolean
Only applicable when there are two dimensions. Continues the moving average across both dimensions.
disabled boolean
steps number
Only applicable when fullRange is set to false. The number of steps in the dimension which form a moving average. Only zero and positive integers are accepted. Note: Sorting order of dimension values (or step order) is important and affects results.

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

Media Library structure that will be evaluated by the engine.

Properties

qUrl string
Required
Value of media library image

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 = ""

Nebula Line chart

properties namespace

Properties

Accumulation object

Properties

AttributeDimensionProperties object

Properties

AttributeExpressionProperties ColorAttributes | CustomTooltipAttributes | ForecastAttributes

Axis object

Properties

AxisStyling object

Properties

byDimDef object

Properties

byMeasureDef object

Properties

ColorAttributes object

Properties

Component Line | Label | Axis | Legend

CustomTooltipAttributes object

Properties

CustomTooltipAttributes

Difference object

Properties

DimensionForecast object

Properties

DimensionProperties object

Properties

dimRefLine object

Properties

FontStyling object

Properties

ForecastAttributes object

Properties

ImageComponent object

Properties

InlineDimensionDef object

Properties

InlineMeasureDef object

Properties

Label object

Properties

LabelNameStyling object

Properties

LabelValueStyling object

Properties

Legend object

Properties

LegendStyling object

Properties

Line object

Properties

LineStyling object

Properties

MasterVisualizationChart object

Properties

MasterVisualizationChartObject object

Properties

MasterVisualizationChartStyle object

Properties

MeasureForecast object

Properties

MeasureProperties object

Properties

MediaLibraryRef object

Properties

Modifier Accumulation | Difference | MovingAverage

MovingAverage object

Properties

paletteColor object

Properties

qStaticContentUrlDef object

Properties

refLine object

Properties

refLineStyle object

Properties