Black Lives Matter. Please consider donating to Black Girls Code today.

JavaScript Figure Reference: indicator Traces

A indicator trace is an object with the key "type" equal to "indicator" (i.e. {"type": "indicator"}) and any of the keys listed below.

An indicator is used to visualize a single `value` along with some contextual information such as `steps` or a `threshold`, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a `reference`. Gauges can be either angular or bullet (aka linear) gauges.

  • type
    Parent: data[type=indicator]
    Type: "indicator"
  • name
    Parent: data[type=indicator]
    Type: string

    Sets the trace name. The trace name appear as the legend item and on hover.

  • title
    Parent: data[type=indicator]
    Type: object containing one or more of the keys listed below.
    • text
      Parent: data[type=indicator].title
      Type: string

      Sets the title of this indicator.

    • align
      Parent: data[type=indicator].title
      Type: enumerated , one of ( "left" | "center" | "right" )

      Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it defaults to right.

    • font
      Parent: data[type=indicator].title
      Type: object containing one or more of the keys listed below.

      Set the font used to display the title

      • family
        Parent: data[type=indicator].title.font
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

      • size
        Parent: data[type=indicator].title.font
        Type: number greater than or equal to 1
      • color
        Parent: data[type=indicator].title.font
        Type: color
  • visible
    Parent: data[type=indicator]
    Type: enumerated , one of ( true | false | "legendonly" )
    Default: true

    Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

  • mode
    Parent: data[type=indicator]
    Type: flaglist string. Any combination of "number", "delta", "gauge" joined with a "+"
    Examples: "number", "delta", "number+delta", "number+delta+gauge"
    Default: "number"

    Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis.

  • ids
    Parent: data[type=indicator]
    Type: data array

    Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

  • value
    Parent: data[type=indicator]
    Type: number

    Sets the number to be displayed.

  • meta
    Parent: data[type=indicator]
    Type: number or categorical coordinate string

    Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

  • customdata
    Parent: data[type=indicator]
    Type: data array

    Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, "scatter" traces also appends customdata items in the markers DOM elements

  • domain
    Parent: data[type=indicator]
    Type: object containing one or more of the keys listed below.
    • x
      Parent: data[type=indicator].domain
      Type: array
      Default: [0, 1]

      Sets the horizontal domain of this indicator trace (in plot fraction).

    • y
      Parent: data[type=indicator].domain
      Type: array
      Default: [0, 1]

      Sets the vertical domain of this indicator trace (in plot fraction).

    • row
      Parent: data[type=indicator].domain
      Type: integer greater than or equal to 0
      Default: 0

      If there is a layout grid, use the domain for this row in the grid for this indicator trace .

    • column
      Parent: data[type=indicator].domain
      Type: integer greater than or equal to 0
      Default: 0

      If there is a layout grid, use the domain for this column in the grid for this indicator trace .

  • align
    Parent: data[type=indicator]
    Type: enumerated , one of ( "left" | "center" | "right" )

    Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered

  • delta
    Parent: data[type=indicator]
    Type: object containing one or more of the keys listed below.
    • reference
      Parent: data[type=indicator].delta
      Type: number

      Sets the reference value to compute the delta. By default, it is set to the current value.

    • position
      Parent: data[type=indicator].delta
      Type: enumerated , one of ( "top" | "bottom" | "left" | "right" )
      Default: "bottom"

      Sets the position of delta with respect to the number.

    • relative
      Parent: data[type=indicator].delta
      Type: boolean

      Show relative change

    • valueformat
      Parent: data[type=indicator].delta
      Type: string

      Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    • increasing
      Parent: data[type=indicator].delta
      Type: object containing one or more of the keys listed below.
      • symbol
        Parent: data[type=indicator].delta.increasing
        Type: string
        Default: "▲"

        Sets the symbol to display for increasing value

      • color
        Parent: data[type=indicator].delta.increasing
        Type: color
        Default: "#3D9970"

        Sets the color for increasing value.

    • decreasing
      Parent: data[type=indicator].delta
      Type: object containing one or more of the keys listed below.
      • symbol
        Parent: data[type=indicator].delta.decreasing
        Type: string
        Default: "▼"

        Sets the symbol to display for increasing value

      • color
        Parent: data[type=indicator].delta.decreasing
        Type: color
        Default: "#FF4136"

        Sets the color for increasing value.

    • font
      Parent: data[type=indicator].delta
      Type: object containing one or more of the keys listed below.

      Set the font used to display the delta

      • family
        Parent: data[type=indicator].delta.font
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

      • size
        Parent: data[type=indicator].delta.font
        Type: number greater than or equal to 1
      • color
        Parent: data[type=indicator].delta.font
        Type: color
  • number
    Parent: data[type=indicator]
    Type: object containing one or more of the keys listed below.
    • valueformat
      Parent: data[type=indicator].number
      Type: string
      Default: ""

      Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

    • font
      Parent: data[type=indicator].number
      Type: object containing one or more of the keys listed below.

      Set the font used to display main number

      • family
        Parent: data[type=indicator].number.font
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

      • size
        Parent: data[type=indicator].number.font
        Type: number greater than or equal to 1
      • color
        Parent: data[type=indicator].number.font
        Type: color
    • prefix
      Parent: data[type=indicator].number
      Type: string
      Default: ""

      Sets a prefix appearing before the number.

    • suffix
      Parent: data[type=indicator].number
      Type: string
      Default: ""

      Sets a suffix appearing next to the number.

  • gauge
    Parent: data[type=indicator]
    Type: object containing one or more of the keys listed below.

    The gauge of the Indicator plot.

    • shape
      Parent: data[type=indicator].gauge
      Type: enumerated , one of ( "angular" | "bullet" )
      Default: "angular"

      Set the shape of the gauge

    • bar
      Parent: data[type=indicator].gauge
      Type: object containing one or more of the keys listed below.

      Set the appearance of the gauge's value

      • color
        Parent: data[type=indicator].gauge.bar
        Type: color
        Default: "green"

        Sets the background color of the arc.

      • line
        Parent: data[type=indicator].gauge.bar
        Type: object containing one or more of the keys listed below.
        • color
          Parent: data[type=indicator].gauge.bar.line
          Type: color
          Default: "#444"

          Sets the color of the line enclosing each sector.

        • width
          Parent: data[type=indicator].gauge.bar.line
          Type: number greater than or equal to 0
          Default: 0

          Sets the width (in px) of the line enclosing each sector.

      • thickness
        Parent: data[type=indicator].gauge.bar
        Type: number between or equal to 0 and 1
        Default: 1

        Sets the thickness of the bar as a fraction of the total thickness of the gauge.

    • bgcolor
      Parent: data[type=indicator].gauge
      Type: color

      Sets the gauge background color.

    • bordercolor
      Parent: data[type=indicator].gauge
      Type: color
      Default: "#444"

      Sets the color of the border enclosing the gauge.

    • borderwidth
      Parent: data[type=indicator].gauge
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the border enclosing the gauge.

    • axis
      Parent: data[type=indicator].gauge
      Type: object containing one or more of the keys listed below.
      • range
        Parent: data[type=indicator].gauge.axis
        Type: array

        Sets the range of this axis.

      • visible
        Parent: data[type=indicator].gauge.axis
        Type: boolean
        Default: true

        A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false

      • tickmode
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        Sets the tick mode for this axis. If "auto", the number of ticks is set via `nticks`. If "linear", the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ("linear" is the default value if `tick0` and `dtick` are provided). If "array", the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ("array" is the default value if `tickvals` is provided).

      • nticks
        Parent: data[type=indicator].gauge.axis
        Type: integer greater than or equal to 0
        Default: 0

        Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".

      • tick0
        Parent: data[type=indicator].gauge.axis
        Type: number or categorical coordinate string

        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`="L<f>" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

      • dtick
        Parent: data[type=indicator].gauge.axis
        Type: number or categorical coordinate string

        Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. If the axis `type` is "log", then ticks are set every 10^(n"dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. "log" has several special values; "L<f>", where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use "D1" (all digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and "D2". If the axis `type` is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. "date" also has special values "M<n>" gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to "2000-01-15" and `dtick` to "M3". To set ticks every 4 years, set `dtick` to "M48"

      • tickvals
        Parent: data[type=indicator].gauge.axis
        Type: data array

        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.

      • ticktext
        Parent: data[type=indicator].gauge.axis
        Type: data array

        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.

      • ticks
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: "outside"

        Determines whether ticks are drawn or not. If "", this axis' ticks are not drawn. If "outside" ("inside"), this axis' are drawn outside (inside) the axis lines.

      • ticklen
        Parent: data[type=indicator].gauge.axis
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickwidth
        Parent: data[type=indicator].gauge.axis
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • tickcolor
        Parent: data[type=indicator].gauge.axis
        Type: color
        Default: "#444"

        Sets the tick color.

      • showticklabels
        Parent: data[type=indicator].gauge.axis
        Type: boolean
        Default: true

        Determines whether or not the tick labels are drawn.

      • tickfont
        Parent: data[type=indicator].gauge.axis
        Type: object containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • family
          Parent: data[type=indicator].gauge.axis.tickfont
          Type: string

          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New Roman".

        • size
          Parent: data[type=indicator].gauge.axis.tickfont
          Type: number greater than or equal to 1
        • color
          Parent: data[type=indicator].gauge.axis.tickfont
          Type: color
      • tickangle
        Parent: data[type=indicator].gauge.axis
        Type: angle
        Default: "auto"

        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.

      • tickformat
        Parent: data[type=indicator].gauge.axis
        Type: string
        Default: ""

        Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-time-format#locale_format We add one item to d3's date formatter: "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"

      • tickformatstops
        Parent: data[type=indicator].gauge.axis
        Type: array of object where each object has one or more of the keys listed below.
        • enabled
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: boolean
          Default: true

          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

        • dtickrange
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: array

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • value
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

        • name
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=indicator].gauge.axis.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.

      • tickprefix
        Parent: data[type=indicator].gauge.axis
        Type: string
        Default: ""

        Sets a tick label prefix.

      • showtickprefix
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all tick labels are displayed with a prefix. If "first", only the first tick is displayed with a prefix. If "last", only the last tick is displayed with a suffix. If "none", tick prefixes are hidden.

      • ticksuffix
        Parent: data[type=indicator].gauge.axis
        Type: string
        Default: ""

        Sets a tick label suffix.

      • showticksuffix
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • separatethousands
        Parent: data[type=indicator].gauge.axis
        Type: boolean

        If "true", even 4-digit integers are separated

      • exponentformat
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If "none", it appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If "B", 1B.

      • showexponent
        Parent: data[type=indicator].gauge.axis
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        If "all", all exponents are shown besides their significands. If "first", only the exponent of the first tick is shown. If "last", only the exponent of the last tick is shown. If "none", no exponents appear.

    • steps
      Parent: data[type=indicator].gauge
      Type: array of object where each object has one or more of the keys listed below.
      • color
        Parent: data[type=indicator].gauge.steps[]
        Type: color

        Sets the background color of the arc.

      • line
        Parent: data[type=indicator].gauge.steps[]
        Type: object containing one or more of the keys listed below.
        • color
          Parent: data[type=indicator].gauge.steps[].line
          Type: color
          Default: "#444"

          Sets the color of the line enclosing each sector.

        • width
          Parent: data[type=indicator].gauge.steps[].line
          Type: number greater than or equal to 0
          Default: 0

          Sets the width (in px) of the line enclosing each sector.

      • thickness
        Parent: data[type=indicator].gauge.steps[]
        Type: number between or equal to 0 and 1
        Default: 1

        Sets the thickness of the bar as a fraction of the total thickness of the gauge.

      • range
        Parent: data[type=indicator].gauge.steps[]
        Type: array

        Sets the range of this axis.

      • name
        Parent: data[type=indicator].gauge.steps[]
        Type: string

        When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.

      • templateitemname
        Parent: data[type=indicator].gauge.steps[]
        Type: string

        Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.

    • threshold
      Parent: data[type=indicator].gauge
      Type: object containing one or more of the keys listed below.
      • line
        Parent: data[type=indicator].gauge.threshold
        Type: object containing one or more of the keys listed below.
        • color
          Parent: data[type=indicator].gauge.threshold.line
          Type: color
          Default: "#444"

          Sets the color of the threshold line.

        • width
          Parent: data[type=indicator].gauge.threshold.line
          Type: number greater than or equal to 0
          Default: 1

          Sets the width (in px) of the threshold line.

      • thickness
        Parent: data[type=indicator].gauge.threshold
        Type: number between or equal to 0 and 1
        Default: 0.85

        Sets the thickness of the threshold line as a fraction of the thickness of the gauge.

      • value
        Parent: data[type=indicator].gauge.threshold
        Type: number

        Sets a treshold value drawn as a line.

  • uirevision
    Parent: data[type=indicator]
    Type: number or categorical coordinate string

    Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.