Nebula Histogram chart

Histogram generic object definition

Download specification

experimental

properties namespace

Properties

  • bins object
    Required

    Bin settings.

    Show bins properties
    • auto boolean
      Required

      Auto mode generates a nice looking histogram without special parameters.

    • binCount number
      Required

      Number of bars to be displayed, used when binMode is set to 'maxCount'.

      default = ""

    • binMode string
      Required

      MaxCount - Able to adjust the maximum number of bars to be displayed. size - Able to adjust size of bars and offset from x-axis.

    • binSize number
      Required

      The width of the bars, used when binMode is set to 'size'.

    • countDistinct boolean
      Required

      Shows unique values.

    • offset number
      Required

      Used to know where to start displaying bars on x-axis.
  • color object
    Required

    Color settings.

    Show color properties
    • bar object
      Required
      Show bar properties
      • paletteColor paletteColor
        Required

        The paletteColor object is used to define the bar color.

        default = "{ index: 6 }"

        Show paletteColor properties
        • color string
          Required

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

        • index number
          Required

          Index in palette
  • dataPoint object
    Required

    Data points

    Show dataPoint properties
    • showLabels boolean
      Required

      Show labels on bars

      default = false

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

    • label string  |  StringExpression

      Label to show on the measure axis, if left empty it defaults to 'Frequency'

      default = ""

    • 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

  • 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 true
      Required

      Sort automatically

      default = true

  • 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

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