Nebula Combo chart

Combo chart generic object definition

Download specification

properties namespace

Properties

  • barGrouping object
    Required

    Bar grouping.

    Show barGrouping properties
    • grouping 'stacked'  |  'grouped'
      Required

      Group setting

  • 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.

    • 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.

    • dimensionScheme '12'  |  '100'
      Required

      Color scheme when "mode": "byDimension" or "mode": "byMultiple" ("12" or "100" for most themes).

    • expressionIsColor boolean
      Required

      Set to define whether the result of the expression is a valid CSS3 color. Only applicable when "mode": "byExpression".

    • expressionLabel string
      Required

      Label to be defined on tool tips when using a coloring expression. Only used if 'expressionIsColor': false.

    • measureMax number  |  ValueExpression
      Required

      Set the max value for the color range. Only applicable if "autoMinMax": false.

    • measureMin number  |  ValueExpression
      Required

      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 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.
    • 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 paletteColor
      Required

      The paletteColor object is used to define the color when you color by single color ("mode": "primary").

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

    • reverseScheme boolean
      Required

      Set to reverse the color scheme.

    • useBaseColors 'off'  |  'dimension'  |  'measure'
      Required

      Use colors encoded in master items. Only applicable when "mode": "primary" or "mode": "byMultiple" has been defined.

    • useDimColVal boolean
      Required

      Set to true if you want to apply the colors defined for library dimensions when used. Only applicable if 'colorMode': 'byDimension'.

    • useMeasureGradient boolean
      Required

      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 object
    Required

    Data point settings.

    Show dataPoint properties
    • show boolean
      Required

      Show line series data points.

    • showBarLabels boolean
      Required

      Show labels on bar series.

    • showLineLabels boolean
      Required

      Show labels on line series data points.

  • dimensionAxis object
    Required

    Dimension axis settings.

    Show dimensionAxis properties
    • axisDisplayMode 'auto'  |  'custom'  |  'max'
      Required

      Set to specify axis display mode (number of bars).

    • continuousAuto boolean
      Required

      Continuous setting used for toggling between auto and custom setting

    • dock 'near'  |  'far'
      Required

      Axis docking position

    • label 'auto'  |  'horizontal'  |  'tilted'
      Required

      Label orientation

    • maxVisibleItems number  |  ValueExpression
      Required

      Only visible when axisDisplayMode is custom. Max = 10000 / (numDims+numMeasures)

    • show 'all'  |  'labels'  |  'title'  |  'none'
      Required

      Labels and title

  • footnote string  |  StringExpression

    Visualization footnote.

  • legend object
    Required

    Legend settings.

    Show legend properties
    • dock 'auto'  |  'right'  |  'left'  |  'bottom'  |  'top'
      Required

      Sets the legend position.

    • show boolean
      Required

      Set to show the legend.

    • showTitle boolean
      Required

      Show the legend title.

  • measureAxes Array< measureAxis >
    Required

    Measure axes settings. Must be an array with 2 measureAxis objects.

  • nullMode 'gap'  |  'connect'  |  'zero'

    Null value presentation

  • orientation 'vertical'  |  'horizontal'
    Required

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

  • 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.

  • qHyperCubeDef object
    Required

    Extends HyperCubeDef, see Engine API: HyperCubeDef.

    Show qHyperCubeDef properties
    • qAlwaysFullyExpanded boolean
      Required
    • qDimensions Array< DimensionProperties >
      Required
    • qMeasures Array< MeasureProperties >
      Required
    • qSuppressMissing boolean
      Required
    • qSuppressZero boolean
      Required
  • 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 primary measure axis reference line definitions

    • refLines2 Array< refLine >
      Required

      Array of secondary measure axis reference line definitions

  • scrollStartPos number
    Required

    Scroll Alignment. Decides if the scroll starts at the beginning or end of the data. Where 0 means at the beginning and 1 at the end.

  • showMiniChartForContinuousAxis boolean
    Required

    Chart axis setting to turn on/off the mini chart for continuous axis.

  • showTitles boolean

    Show title for the visualization.

  • subtitle string  |  StringExpression

    Visualization subtitle.

  • title string  |  StringExpression

    Visualization title.

  • tooltip object
    Required

    Custom tooltip properties

    Show tooltip properties
    • auto boolean
      Required

      Toggle for using custom tooltip or regular tooltip

    • The chart object is used to define the chart displayed by the custom tooltip.

      Show chart properties
      • 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

      • 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.

    • hideBasic boolean
      Required

      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.

    • title string  |  StringExpression

      Custom tooltip title.

  • version string
    Required

    Current version of this generic object definition.

Accumulation object

It allows you to accumulate values of your measure over one dimension.

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

  • 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.

AttributeDimensionProperties object

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

AttributeExpressionProperties ColorAttributes  |  CustomTooltipAttributes

Axis object

Properties

  • Required
    Show axis properties
    • Required
      Show label properties
    • Required
      Show title properties
      • 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).

AxisStyling object

Properties

  • Required
    Show label properties
  • Required
    Show title properties
    • 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

Bar object

Properties

  • Required
    Show bar properties
    • Required

      Bar labels if bar and data point labels if line.

      Show label properties
  • key string
    Required

    This should be set to "bar" (Determines which component the settings apply to).

  • Required
    Show style properties
    • strokeColor paletteColor
      Required
      Show strokeColor properties
      • color string
        Required

        Color as hex string (mandatory if index: -1)

      • index number
        Required

        Index in palette

    • strokeWidth 'none'  |  'small'  |  'medium'  |  'large'
      Required

      Set to specify stroke width.

    • width number
      Required

      A number greater than 0 and less than or equal to 1.

BarStyling object

Properties

  • strokeColor paletteColor
    Required
    Show strokeColor properties
    • color string
      Required

      Color as hex string (mandatory if index: -1)

    • index number
      Required

      Index in palette

  • strokeWidth 'none'  |  'small'  |  'medium'  |  'large'
    Required

    Set to specify stroke width.

  • width number
    Required

    A number greater than 0 and less than or equal to 1.

ChartStyling object

Properties

  • Required

    Bar labels if bar and data point labels if line.

    Show label properties
    • Required
      Show value properties
      • 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

ColorAttributes object

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"), colorByExpression together with color.mode="byExpression" or colorByMeasureExpression togehter with color.mode="byExpression" on the current measure.

Component Line  |  Bar  |  Axis  |  Legend

CustomTooltipAttributes object

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"
}]
```

DimensionProperties object

Extends NxDimension, see Engine API: NxDimension.

Properties

dimRefLine object

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
  • show boolean  |  ValueExpression
    Required

    Set to true to display this reference line.

  • align 'start'  |  'center'  |  'end'

    Set alignment for this reference line

  • coloredBackground boolean

    Set to true to fill the label and/or value of this reference line with this color

  • showLabel boolean

    Set to true to show the label of this reference line.

  • showValue boolean

    Set to true to show the value of this reference line.

  • Styling settings for reference line

    Show style properties
    • lineThickness number

      Set the thickness for this reference line.

    • lineType string

      Set the dash type for this reference line.

FontStyling object

Properties

  • 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

ImageComponent object

Image component information structure.

Properties

  • cId string
    Required

    Identifier of the image component - used as a link with an attribute expression

  • 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'

InlineDimensionDef object

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.

InlineMeasureDef object

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).

  • 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.

  • Set to define color for this measure

    Show color properties
    • mode 'primary'  |  'byExpression'
      Required

      Sets the coloring mode for the measure when coloring has been switched on Can be one of:

      • primary: a single color (by default blue) is used. single color is the default setting.
      • byExpression: coloring is based on an expression. The expression are set in the "colorExpression" property.
    • on boolean
      Required

      Set if the color settings should be used

    • paletteColor paletteColor
      Required

      index: 6 } The paletteColor object is used to define the color when you color by single color ("mode": "primary").

      Show paletteColor properties
      • color string
        Required

        Color as hex string (mandatory if index: -1)

      • index number
        Required

        Index in palette

    • colorExpression string

      Sets the color expression to be used when "mode": "byExpression" is defined. Expression is a color code. Supported formats are: RGB, ARGB and HSL

  • modifiers Array< Modifier >

    Set to apply a modifier to a measure.

  • series Series

    Set to define type of series and series options

    Show series properties
    • Required

      Set options specific for a series.

      Show options properties
      • fill boolean

        Set to true if the marker should be filled with a color. If false, only stroke of the marker is rendered.

      • type 'circle'  |  'line'  |  'diamond'  |  'triangle'  |  'rect'

        Set the type of marker.

    • axis 0  |  1

      Set which axes the series should be represented on. 0 for primary axis and 1 for secondary axis. Defaults to primary with less than 2 measure, otherwise secondary axis.

    • type 'bar'  |  'line'  |  'marker'

      Set the type of series. Defaults to 'bar' with less than 2 measure, otherwise 'line'.

LabelNameStyling object

Properties

  • Required
    Show name properties
    • 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

LabelValueStyling object

Properties

  • Required
    Show value properties
    • 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

Legend object

Properties

  • key string
    Required

    This should be set to "legend" (Determines which component the settings apply to).

  • Required
    Show legend properties
    • Required
      Show label properties
    • Required
      Show title properties
      • 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

LegendStyling object

Properties

  • Required
    Show label properties
  • Required
    Show title properties
    • 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

Line object

Properties

  • key string
    Required

    This should be set to "line" (Determines which component the settings apply to).

  • Required
    Show line properties
    • Required

      Bar labels if bar and data point labels if line.

      Show label properties
      • Required
        Show value properties
        • 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
  • Required
    Show style properties
    • dataPointSize number
      Required

      Set to specify the size of the data point.

    • lineCurve 'linear'  |  'monotone'
      Required
    • lineThickness number
      Required

      Set to specify line thickness. Can be set from 1 to 5.

    • lineType 'solid'  |  'dashed'
      Required

LineStyling object

Properties

  • dataPointSize number
    Required

    Set to specify the size of the data point.

  • lineCurve 'linear'  |  'monotone'
    Required
  • lineThickness number
    Required

    Set to specify line thickness. Can be set from 1 to 5.

  • lineType 'solid'  |  'dashed'
    Required

MasterVisualizationChart object

Chart component information structure.

Properties

  • 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

  • Object containing the styles of the chart such as 'size'

    Show style properties
    • size string
      Required

      Input type as 'small' or 'medium' or 'large'

MasterVisualizationChartObject object

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

MasterVisualizationChartStyle object

Chart component information structure.

Properties

  • size string
    Required

    Input type as 'small' or 'medium' or 'large'

measureAxis object

Properties

  • 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

  • min 'min'  |  'max'  |  'minMax'
    Required

    Axis min value. "autoMinMax" must be set to false and "minMax" must be set to "min" or "minMax" to use this property

  • minMax 'min'  |  'max'  |  'minMax'
    Required

    Set custom max/min

  • autoMinMax boolean

    Automatic max/min

  • dock 'near'  |  'far'

    Axis docking position

  • show 'all'  |  'labels'  |  'title'  |  'none'

    Labels and title

  • spacing number

    Axis scale

MeasureColor object

Series information that defines the type of series and how it is represented.

Properties

  • mode 'primary'  |  'byExpression'
    Required

    Sets the coloring mode for the measure when coloring has been switched on Can be one of:

    • primary: a single color (by default blue) is used. single color is the default setting.
    • byExpression: coloring is based on an expression. The expression are set in the "colorExpression" property.
  • on boolean
    Required

    Set if the color settings should be used

  • paletteColor paletteColor
    Required

    index: 6 } The paletteColor object is used to define the color when you color by single color ("mode": "primary").

    Show paletteColor properties
    • color string
      Required

      Color as hex string (mandatory if index: -1)

    • index number
      Required

      Index in palette

  • colorExpression string

    Sets the color expression to be used when "mode": "byExpression" is defined. Expression is a color code. Supported formats are: RGB, ARGB and HSL

MeasureProperties object

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

  • qAttributeExpressions Array< AttributeExpressionProperties >
    Required
  • 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).

    • 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.

    • Set to define color for this measure

      Show color properties
      • mode 'primary'  |  'byExpression'
        Required

        Sets the coloring mode for the measure when coloring has been switched on Can be one of:

        • primary: a single color (by default blue) is used. single color is the default setting.
        • byExpression: coloring is based on an expression. The expression are set in the "colorExpression" property.
      • on boolean
        Required

        Set if the color settings should be used

      • paletteColor paletteColor
        Required

        index: 6 } The paletteColor object is used to define the color when you color by single color ("mode": "primary").

        Show paletteColor properties
        • color string
          Required

          Color as hex string (mandatory if index: -1)

        • index number
          Required

          Index in palette

      • colorExpression string

        Sets the color expression to be used when "mode": "byExpression" is defined. Expression is a color code. Supported formats are: RGB, ARGB and HSL

    • modifiers Array< Modifier >

      Set to apply a modifier to a measure.

    • series Series

      Set to define type of series and series options

      Show series properties
      • Required

        Set options specific for a series.

        Show options properties
        • fill boolean

          Set to true if the marker should be filled with a color. If false, only stroke of the marker is rendered.

        • type 'circle'  |  'line'  |  'diamond'  |  'triangle'  |  'rect'

          Set the type of marker.

      • axis 0  |  1

        Set which axes the series should be represented on. 0 for primary axis and 1 for secondary axis. Defaults to primary with less than 2 measure, otherwise secondary axis.

      • type 'bar'  |  'line'  |  'marker'

        Set the type of series. Defaults to 'bar' with less than 2 measure, otherwise 'line'.

MediaLibraryRef object

Media Library Reference structure.

Properties

  • qStaticContentUrlDef object
    Required

    Media library structure

type Modifier Accumulation

paletteColor object

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

qStaticContentUrlDef object

Media Library structure that will be evaluated by the engine.

Properties

  • qUrl string
    Required

    Value of media library image

refLine object

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
  • show boolean  |  ValueExpression
    Required

    Set to true to display this reference line.

  • coloredBackground boolean

    Set to true to fill the label and/or value of this reference line with this color

  • showLabel boolean

    Set to true to show the label of this reference line.

  • showValue boolean

    Set to true to show the value of this reference line.

  • Styling settings for reference line

    Show style properties
    • lineThickness number

      Set the thickness for this reference line.

    • lineType string

      Set the dash type for this reference line.

refLineStyle object

Styling settings for reference line

Properties

  • lineThickness number

    Set the thickness for this reference line.

  • lineType string

    Set the dash type for this reference line.

Series object

Series information that defines the type of series and how it is represented.

Properties

  • Required

    Set options specific for a series.

    Show options properties
    • fill boolean

      Set to true if the marker should be filled with a color. If false, only stroke of the marker is rendered.

    • type 'circle'  |  'line'  |  'diamond'  |  'triangle'  |  'rect'

      Set the type of marker.

  • axis 0  |  1

    Set which axes the series should be represented on. 0 for primary axis and 1 for secondary axis. Defaults to primary with less than 2 measure, otherwise secondary axis.

  • type 'bar'  |  'line'  |  'marker'

    Set the type of series. Defaults to 'bar' with less than 2 measure, otherwise 'line'.

SeriesMarkerOptions object

Series options for the Marker type.

Properties

  • fill boolean

    Set to true if the marker should be filled with a color. If false, only stroke of the marker is rendered.

  • type 'circle'  |  'line'  |  'diamond'  |  'triangle'  |  'rect'

    Set the type of marker.