Nebula Waterfall chart

Waterfall chart 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
    • 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

    • negativeValue object
      Required

      Negative value color.

      Show negativeValue properties
      • paletteColor paletteColor
        Required

        paletteColor

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

        Show paletteColor properties
        • color string
          Required

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

        • index number
          Required

          Index in palette
    • positiveValue object
      Required

      Positive value color.

      Show positiveValue properties
      • paletteColor paletteColor
        Required

        paletteColor

        default = "{ index: 6, color: null }"

    • subtotal object
      Required

      Subtotal value color.

      Show subtotal properties
      • paletteColor paletteColor
        Required

        paletteColor

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

  • dataPoint object
    Required

    Data point.

    Show dataPoint properties
    • showLabels boolean
      Required

      Show labels.

      default = true

  • dimensionAxis object
    Required

    Dimension axis settings.

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

      Axis docking position

      default = "near"

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

      Label orientation

      default = "auto"

    • show 'labels'  |  'none'
      Required

      Labels and title

      default = "labels"

  • 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

  • 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

  • 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 'labels'  |  'none'
      Required

      Labels and title

      default = "labels"

    • spacing number
      Required

      Axis scale

      default = 1

  • qHyperCubeDef object
    Required

    Extends HyperCubeDef, see Engine API: HyperCubeDef.

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

  • subtitle string  |  StringExpression

    Visualization subtitle.

    default = ""

  • title string  |  StringExpression

    Visualization title.

    default = ""

  • version string
    Required

    Current version of this generic object definition.

FieldAttributes object

Field attributes structure.

Properties

  • dec string
    Required

    Defines the decimal separator.

  • Fmt string
    Required

    Defines the format pattern that applies to qText.

  • nDec number
    Required

    Number of decimals.

  • Thou string
    Required

    Defines the thousand separator (if any).

  • Type string
    Required

    Type of the field.

  • UseThou number
    Required

    Defines whether or not a thousands separator must be used.

InlineMeasureDef object

extends NxInlineMeasureDef

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Properties

  • subtotal subtotalProperties
    Required

    subtotal settings.

    Show subtotal properties
    • enable boolean
      Required

      Option to add a subtotal after a measure.

      default = false

    • label string
      Required

      Label of the subtotal added after a measure.

      default = "Subtotal"

  • valueType 'NORMAL'  |  'INVERSE'  |  'SUBTOTAL'
    Required

    Measure operation.

    default = "NORMAL"

MeasureProperties object

extends NxMeasure

Extends NxMeasure, see Engine API: NxMeasure.

Properties

  • qDef InlineMeasureDef
    Required
    Show qDef properties
    • subtotal subtotalProperties
      Required

      subtotal settings.

      Show subtotal properties
      • enable boolean
        Required

        Option to add a subtotal after a measure.

        default = false

      • label string
        Required

        Label of the subtotal added after a measure.

        default = "Subtotal"

    • valueType 'NORMAL'  |  'INVERSE'  |  'SUBTOTAL'
      Required

      Measure operation.

      default = "NORMAL"

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.qDef.isCustomFormatted boolean

If true, the client formatting will be toggled off.

default = false

properties.qDef.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

properties.qDef.qNumFormat FieldAttributes

see Engine API: FieldAttributes.

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

subtotalProperties object

Settings for subtotal

Properties

  • enable boolean
    Required

    Option to add a subtotal after a measure.

    default = false

  • label string
    Required

    Label of the subtotal added after a measure.

    default = "Subtotal"