Nebula Distribution plot chart

Distributionplot generic object definition

Download specification

experimental

properties namespace

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
    • box object
      Required
      Show box properties
      • paletteColor paletteColor
        Required

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

        default = "{ index: -1, color: '#e6e6e6' }"

        Show paletteColor properties
        • color string
          Required

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

        • index number
          Required

          Index in palette
    • expressionLabel string
      Required

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

      default = ""

    • point object
      Required
      Show point 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

      • expressionIsColor true
        Required

        Should be true

        default = true

      • mode 'primary'  |  'byExpression'  |  '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.
        • 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.
        • 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"

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

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

        default = "off"

  • dimensionAxis object
    Required

    Dimension axis settings.

    Show dimensionAxis properties
    • dock 'near'  |  'far'
      Required

      Axis docking position

      default = "near"

    • label 'auto'
      Required

      Label orientation

      default = "auto"

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

      Labels and title

      default = "all"

  • footnote string  |  StringExpression

    Visualization footnote.

    default = ""

  • gridlines object
    Required

    Grid lines settings.

    Show gridlines properties
    • auto boolean
      Required

      Automatic grid line spacing.

      default = true

    • spacing 0  |  2  |  3
      Required

      Grid line spacing. Used only when auto is set to false.

      default = 2

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

    • 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

  • orientation 'vertical'  |  'horizontal'
    Required

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

    default = "horizontal"

  • presentation object
    Required

    Presentation settings for the distributionplot

    Show presentation properties
    • visibleComponents 'points_box'  |  'points'  |  'box'
      Required

      Visible components of the distributionplot

      default = "points_box"

  • qHyperCubeDef object
    Required

    Extends HyperCubeDef, see Engine API: HyperCubeDef.

  • refLine object
    Required

    Reference lines settings

    Show refLine properties
    • refLines Array< refLine >
      Required

      Array of measure based reference line definitions
  • showTitles boolean

    Show title for the visualization.

    default = true

  • sorting object
    Required

    Wrapper for sorting properties which will be set on the outer dimension.

    Show sorting properties
    • autoSort boolean
      Required

      Sort automatically

      default = true

    • elementId 'distplot-exp-min'  |  'distplot-exp-max'
      Required

      Sorting preset

      default = "distplot-exp-min"

    • expression ValueExpression
      Required

      Expression for the sorting. Requires sortByExpression to be -1 or 1.

    • sortCriteria object
      Required
      Show sortCriteria properties
      • sortByAscii number
        Required

        Sort by alphabetic

        default = 0

      • sortByExpression number
        Required

        Sort by expression

        default = 0

      • sortByNumeric number
        Required

        Sort by numeric

        default = 0

      • sortByLoadOrder number
        Required

        Sort by load order

        default = 0

  • subtitle string  |  StringExpression

    Visualization subtitle.

    default = ""

  • title string  |  StringExpression

    Visualization title.

    default = ""

  • version string
    Required

    Current version of this generic object definition.

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

properties.dataPoint.bubbleScales number

Size parameter for points (20 - 100), step is 5.

default = 100

properties.dataPoint.displacement 'none'  |  'jitter'

Property for controlling displacement of data points

default = "none"

refLine object

Properties

  • show boolean  |  ValueExpression
    Required

    Set to true to display this reference line.

    default = true

  • label string
    Required

    Reference line label.

  • 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

  • paletteColor paletteColor
    Required
    Show paletteColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette
  • 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 = ""

  • coloredBackground boolean

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

    default = false

refLineStyle object

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