Nebula Gauge

Gauge generic object definition

Download specification

properties object

extends GenericObjectProperties

Properties

  • autoOrientation boolean
    Required

    Auto orientation, only applicable to bar gauge. If true, the orientation of the bar gauge is adaptive to the aspect ratio of the chart.

    default = true

  • color object
    Required

    Color settings.

    Show color properties
    • useBaseColors 'measure'  |  'off'
      Required

      If should use colors encoded in master items

      default = "measure"

  • components Array< Component >
    Required

    Styling of chart components.

  • footnote string  |  StringExpression

    Footnote of the visualization.

    default = ""

  • gaugetype 'radial'  |  'bar'
    Required

    Gauge type

    default = "radial"

  • measureAxis object
    Required

    Measure axis configuration.

    Show measureAxis properties
    • max number  |  ValueExpression
      Required

      Maximum value for the measure axis.

      default = 100

    • min number  |  ValueExpression
      Required

      Minimum value for the measure axis.

      default = 0

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

      Labels and title

      default = "all"

    • spacing 1  |  0.5  |  2
      Required

      Axis scale

      default = 1

  • orientation 'horizontal'  |  'vertical'
    Required

    Orientation of the bar gauge. Only applicable when autoOrientation is false.

    default = "horizontal"

  • paletteProgressColor PaletteColor
    Required

    Define the progress color. Applicable when useSegment is 'off' and useBaseColors is also 'off'

    Show paletteProgressColor properties
    • color string
      Required

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

    • index number
      Required

      Index in palette
  • qHyperCubeDef object
    Required

    Hypercube definition for the visualization.

    Show qHyperCubeDef properties
    • qInitialDataFetch Array< object >
      Required

      Initial data fetch configuration.

    • qMeasures Array
      Required

      Array of measures for the hypercube.

    • qSuppressMissing boolean
      Required

      Whether to suppress missing values.

      default = true

    • qSuppressZero boolean
      Required

      Whether to suppress zero values.

      default = false

  • refLine object
    Required

    Reference lines settings

    Show refLine properties
    • refLines Array< RefLine >
      Required

      Array of measure based reference line definitions
  • segmentInfo object
    Required

    Segment information for the gauge.

    Show segmentInfo properties
    • limits Array< Limits >
      Required

      Array of segment limits.

    • paletteColors Array< PaletteColor >
      Required

      Array of segment colors.
  • showDetails boolean
    Required

    Show visualization details toggle

    default = true

  • showTitles boolean
    Required

    Whether to show titles for the visualization.

    default = true

  • subtitle string  |  StringExpression

    Subtitle of the visualization.

    default = ""

  • title string  |  StringExpression

    Title of the visualization.

    default = ""

  • useSegments boolean
    Required

    Decide if segments coloring or progress coloring is used. If true, the segments are colored according to the segmentInfo.paletteColors.

    default = false

  • version string
    Required

    Current version of this generic object definition

Axis object

Properties

  • axis AxisStyling
    Required
    Show axis properties
    • label LabelNameStyling
      Required
      Show label properties
    • 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
  • key string
    Required

    This should be set to "axis"

AxisStyling object

Properties

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

Component Label  |  Axis

Expr object

Expression

Properties

  • qExpr string
    Required

    expression as a string, e.g. '=Sum([Actual Amount])', note that the equal sign is optional

FontStyling object

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

Label object

Properties

  • key string
    Required

    This should be set to "value"

  • label LabelValueStyling
    Required
    Show label properties
    • value FontStyling
      Required

      Gauge value label

      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

LabelNameStyling object

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

LabelValueStyling object

Properties

  • value FontStyling
    Required

    Gauge value label

    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

Limits object

The limits between segments colors.

Properties

  • gradient boolean
    Required

    Gradient color (i.e. gradually changing color) or solid color

  • value number  |  ValueExpression
    Required

    Value of the limit

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

  • label string  |  StringExpression
    Required

    Reference line label.

  • paletteColor PaletteColor
    Required

    Color of the reference line and label.

    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.

    default = true

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

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

StringExpression object

String expression

Properties

  • qStringExpression Expr
    Required
    Show qStringExpression properties
    • qExpr string
      Required

      expression as a string, e.g. '=Sum([Actual Amount])', note that the equal sign is optional

ValueExpression object

Value expression

Properties

  • qValueExpression Expr
    Required
    Show qValueExpression properties
    • qExpr string
      Required

      expression as a string, e.g. '=Sum([Actual Amount])', note that the equal sign is optional