Python > Figure Reference > indicator Traces

Python Figure Reference: indicator Traces

A plotly.graph_objects.Indicator trace is a graph object in the figure's data list with any of the named arguments or attributes 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.

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='indicator'))
    Type: string

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

  • title
    Code: fig.update_traces(title=dict(...), selector=dict(type='indicator'))
    Type: dict containing one or more of the keys listed below.
    • align
      Code: fig.update_traces(title_align=<VALUE>, selector=dict(type='indicator'))
      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
      Code: fig.update_traces(title_font=dict(...), selector=dict(type='indicator'))
      Type: dict containing one or more of the keys listed below.

      Set the font used to display the title

      • color
        Code: fig.update_traces(title_font_color=<VALUE>, selector=dict(type='indicator'))
        Type: color
      • family
        Code: fig.update_traces(title_font_family=<VALUE>, selector=dict(type='indicator'))
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

      • lineposition
        Code: fig.update_traces(title_font_lineposition=<VALUE>, selector=dict(type='indicator'))
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

      • shadow
        Code: fig.update_traces(title_font_shadow=<VALUE>, selector=dict(type='indicator'))
        Type: string
        Default: "none"

        Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

      • size
        Code: fig.update_traces(title_font_size=<VALUE>, selector=dict(type='indicator'))
        Type: number greater than or equal to 1
      • style
        Code: fig.update_traces(title_font_style=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "italic" )
        Default: "normal"

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Code: fig.update_traces(title_font_textcase=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Code: fig.update_traces(title_font_variant=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Code: fig.update_traces(title_font_weight=<VALUE>, selector=dict(type='indicator'))
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • text
      Code: fig.update_traces(title_text=<VALUE>, selector=dict(type='indicator'))
      Type: string

      Sets the title of this indicator.

  • visible
    Code: fig.update_traces(visible=<VALUE>, selector=dict(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).

  • legend
    Code: fig.update_traces(legend=<VALUE>, selector=dict(type='indicator'))
    Type: subplotid
    Default: legend

    Sets the reference to a legend to show this trace in. References to these legends are "legend", "legend2", "legend3", etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.

  • legendrank
    Code: fig.update_traces(legendrank=<VALUE>, selector=dict(type='indicator'))
    Type: number
    Default: 1000

    Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with "reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.

  • legendgrouptitle
    Code: fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='indicator'))
    Type: dict containing one or more of the keys listed below.
    • font
      Code: fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='indicator'))
      Type: dict containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Code: fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='indicator'))
        Type: color
      • family
        Code: fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='indicator'))
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

      • lineposition
        Code: fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='indicator'))
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

      • shadow
        Code: fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='indicator'))
        Type: string
        Default: "none"

        Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

      • size
        Code: fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='indicator'))
        Type: number greater than or equal to 1
      • style
        Code: fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "italic" )
        Default: "normal"

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Code: fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Code: fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Code: fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='indicator'))
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • text
      Code: fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='indicator'))
      Type: string
      Default: ""

      Sets the title of the legend group.

  • legendwidth
    Code: fig.update_traces(legendwidth=<VALUE>, selector=dict(type='indicator'))
    Type: number greater than or equal to 0

    Sets the width (in px or fraction) of the legend for this trace.

  • mode
    Code: fig.update_traces(mode=<VALUE>, selector=dict(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
    Code: fig.update_traces(ids=<VALUE>, selector=dict(type='indicator'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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
    Code: fig.update_traces(value=<VALUE>, selector=dict(type='indicator'))
    Type: number

    Sets the number to be displayed.

  • meta
    Code: fig.update_traces(meta=<VALUE>, selector=dict(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
    Code: fig.update_traces(customdata=<VALUE>, selector=dict(type='indicator'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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
    Code: fig.update_traces(domain=dict(...), selector=dict(type='indicator'))
    Type: dict containing one or more of the keys listed below.
    • column
      Code: fig.update_traces(domain_column=<VALUE>, selector=dict(type='indicator'))
      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.

    • row
      Code: fig.update_traces(domain_row=<VALUE>, selector=dict(type='indicator'))
      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.

    • x
      Code: fig.update_traces(domain_x=list(...), selector=dict(type='indicator'))
      Type: list
      Default: [0, 1]

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

    • y
      Code: fig.update_traces(domain_y=list(...), selector=dict(type='indicator'))
      Type: list
      Default: [0, 1]

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

  • align
    Code: fig.update_traces(align=<VALUE>, selector=dict(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
    Code: fig.update_traces(delta=dict(...), selector=dict(type='indicator'))
    Type: dict containing one or more of the keys listed below.
    • decreasing
      Code: fig.update_traces(delta_decreasing=dict(...), selector=dict(type='indicator'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(delta_decreasing_color=<VALUE>, selector=dict(type='indicator'))
        Type: color
        Default: "#FF4136"

        Sets the color for increasing value.

      • symbol
        Code: fig.update_traces(delta_decreasing_symbol=<VALUE>, selector=dict(type='indicator'))
        Type: string
        Default: "▼"

        Sets the symbol to display for increasing value

    • font
      Code: fig.update_traces(delta_font=dict(...), selector=dict(type='indicator'))
      Type: dict containing one or more of the keys listed below.

      Set the font used to display the delta

      • color
        Code: fig.update_traces(delta_font_color=<VALUE>, selector=dict(type='indicator'))
        Type: color
      • family
        Code: fig.update_traces(delta_font_family=<VALUE>, selector=dict(type='indicator'))
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

      • lineposition
        Code: fig.update_traces(delta_font_lineposition=<VALUE>, selector=dict(type='indicator'))
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

      • shadow
        Code: fig.update_traces(delta_font_shadow=<VALUE>, selector=dict(type='indicator'))
        Type: string
        Default: "none"

        Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

      • size
        Code: fig.update_traces(delta_font_size=<VALUE>, selector=dict(type='indicator'))
        Type: number greater than or equal to 1
      • style
        Code: fig.update_traces(delta_font_style=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "italic" )
        Default: "normal"

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Code: fig.update_traces(delta_font_textcase=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Code: fig.update_traces(delta_font_variant=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Code: fig.update_traces(delta_font_weight=<VALUE>, selector=dict(type='indicator'))
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • increasing
      Code: fig.update_traces(delta_increasing=dict(...), selector=dict(type='indicator'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(delta_increasing_color=<VALUE>, selector=dict(type='indicator'))
        Type: color
        Default: "#3D9970"

        Sets the color for increasing value.

      • symbol
        Code: fig.update_traces(delta_increasing_symbol=<VALUE>, selector=dict(type='indicator'))
        Type: string
        Default: "▲"

        Sets the symbol to display for increasing value

    • position
      Code: fig.update_traces(delta_position=<VALUE>, selector=dict(type='indicator'))
      Type: enumerated , one of ( "top" | "bottom" | "left" | "right" )
      Default: "bottom"

      Sets the position of delta with respect to the number.

    • prefix
      Code: fig.update_traces(delta_prefix=<VALUE>, selector=dict(type='indicator'))
      Type: string
      Default: ""

      Sets a prefix appearing before the delta.

    • reference
      Code: fig.update_traces(delta_reference=<VALUE>, selector=dict(type='indicator'))
      Type: number

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

    • relative
      Code: fig.update_traces(delta_relative=<VALUE>, selector=dict(type='indicator'))
      Type: boolean

      Show relative change

    • suffix
      Code: fig.update_traces(delta_suffix=<VALUE>, selector=dict(type='indicator'))
      Type: string
      Default: ""

      Sets a suffix appearing next to the delta.

    • valueformat
      Code: fig.update_traces(delta_valueformat=<VALUE>, selector=dict(type='indicator'))
      Type: string

      Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.

  • number
    Code: fig.update_traces(number=dict(...), selector=dict(type='indicator'))
    Type: dict containing one or more of the keys listed below.
    • font
      Code: fig.update_traces(number_font=dict(...), selector=dict(type='indicator'))
      Type: dict containing one or more of the keys listed below.

      Set the font used to display main number

      • color
        Code: fig.update_traces(number_font_color=<VALUE>, selector=dict(type='indicator'))
        Type: color
      • family
        Code: fig.update_traces(number_font_family=<VALUE>, selector=dict(type='indicator'))
        Type: string

        HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

      • lineposition
        Code: fig.update_traces(number_font_lineposition=<VALUE>, selector=dict(type='indicator'))
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        Sets the kind of decoration line(s) with text, such as an "under", "over" or "through" as well as combinations e.g. "under+over", etc.

      • shadow
        Code: fig.update_traces(number_font_shadow=<VALUE>, selector=dict(type='indicator'))
        Type: string
        Default: "none"

        Sets the shape and color of the shadow behind text. "auto" places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

      • size
        Code: fig.update_traces(number_font_size=<VALUE>, selector=dict(type='indicator'))
        Type: number greater than or equal to 1
      • style
        Code: fig.update_traces(number_font_style=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "italic" )
        Default: "normal"

        Sets whether a font should be styled with a normal or italic face from its family.

      • textcase
        Code: fig.update_traces(number_font_textcase=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

        Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

      • variant
        Code: fig.update_traces(number_font_variant=<VALUE>, selector=dict(type='indicator'))
        Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )