plotly.graph_objects.Indicator

class plotly.graph_objects.Indicator(arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, **kwargs)
__init__(arg=None, align=None, customdata=None, customdatasrc=None, delta=None, domain=None, gauge=None, ids=None, idssrc=None, meta=None, metasrc=None, mode=None, name=None, number=None, stream=None, title=None, uid=None, uirevision=None, value=None, visible=None, **kwargs)

Construct a new Indicator object

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.

Parameters

  • arg – dict of properties compatible with this constructor or an instance of plotly.graph_objects.Indicator

  • align – 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

  • customdata – 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

  • customdatasrc – Sets the source reference on Chart Studio Cloud for customdata .

  • delta – plotly.graph_objects.indicator.Delta instance or dict with compatible properties

  • domain – plotly.graph_objects.indicator.Domain instance or dict with compatible properties

  • gauge – The gauge of the Indicator plot.

  • ids – 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.

  • idssrc – Sets the source reference on Chart Studio Cloud for ids .

  • meta – 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.

  • metasrc – Sets the source reference on Chart Studio Cloud for meta .

  • mode – 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.

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

  • number – plotly.graph_objects.indicator.Number instance or dict with compatible properties

  • stream – plotly.graph_objects.indicator.Stream instance or dict with compatible properties

  • title – plotly.graph_objects.indicator.Title instance or dict with compatible properties

  • uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

  • uirevision – 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.

  • value – Sets the number to be displayed.

  • visible – 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).

Returns

Return type

Indicator

plotly.graph_objects.indicator

plotly.graph_objects.indicator

class plotly.graph_objects.indicator.Delta(arg=None, decreasing=None, font=None, increasing=None, position=None, reference=None, relative=None, valueformat=None, **kwargs)
property decreasing

The ‘decreasing’ property is an instance of Decreasing that may be specified as:

  • An instance of plotly.graph_objects.indicator.delta.Decreasing

  • A dict of string/value properties that will be passed to the Decreasing constructor

    Supported dict properties:

    color

    Sets the color for increasing value.

    symbol

    Sets the symbol to display for increasing value

Returns

Return type

plotly.graph_objects.indicator.delta.Decreasing

property font

Set the font used to display the delta

The ‘font’ property is an instance of Font that may be specified as:

  • An instance of plotly.graph_objects.indicator.delta.Font

  • A dict of string/value properties that will be passed to the Font constructor

    Supported dict properties:

    color

    family

    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

Returns

Return type

plotly.graph_objects.indicator.delta.Font

property increasing

The ‘increasing’ property is an instance of Increasing that may be specified as:

  • An instance of plotly.graph_objects.indicator.delta.Increasing

  • A dict of string/value properties that will be passed to the Increasing constructor

    Supported dict properties:

    color

    Sets the color for increasing value.

    symbol

    Sets the symbol to display for increasing value

Returns

Return type

plotly.graph_objects.indicator.delta.Increasing

property position

Sets the position of delta with respect to the number.

The ‘position’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘top’, ‘bottom’, ‘left’, ‘right’]

Returns

Return type

Any

property reference

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

The ‘reference’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

property relative

Show relative change

The ‘relative’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property valueformat

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

The ‘valueformat’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str

class plotly.graph_objects.indicator.Domain(arg=None, column=None, row=None, x=None, y=None, **kwargs)
property column

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

The ‘column’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property row

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

The ‘row’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property x
Sets the horizontal domain of this indicator trace (in plot

fraction).

The ‘x’ property is an info array that may be specified as:

  • a list or tuple of 2 elements where:

  1. The ‘x[0]’ property is a number and may be specified as:

    • An int or float in the interval [0, 1]

  2. The ‘x[1]’ property is a number and may be specified as:

    • An int or float in the interval [0, 1]

    list

property y
Sets the vertical domain of this indicator trace (in plot

fraction).

The ‘y’ property is an info array that may be specified as:

  • a list or tuple of 2 elements where:

  1. The ‘y[0]’ property is a number and may be specified as:

    • An int or float in the interval [0, 1]

  2. The ‘y[1]’ property is a number and may be specified as:

    • An int or float in the interval [0, 1]

    list

class plotly.graph_objects.indicator.Gauge(arg=None, axis=None, bar=None, bgcolor=None, bordercolor=None, borderwidth=None, shape=None, steps=None, stepdefaults=None, threshold=None, **kwargs)
property axis

The ‘axis’ property is an instance of Axis that may be specified as:

  • An instance of plotly.graph_objects.indicator.gauge.Axis

  • A dict of string/value properties that will be passed to the Axis constructor

    Supported dict properties:

    dtick

    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”

    exponentformat

    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.

    nticks

    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”.

    range

    Sets the range of this axis.

    separatethousands

    If “true”, even 4-digit integers are separated

    showexponent

    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.

    showticklabels

    Determines whether or not the tick labels are drawn.

    showtickprefix

    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.

    showticksuffix

    Same as showtickprefix but for tick suffixes.

    tick0

    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.

    tickangle

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

    tickcolor

    Sets the tick color.

    tickfont

    Sets the color bar’s tick label font

    tickformat

    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-3.x-api- reference/blob/master/Time-Formatting.md#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

    A tuple of plotly.graph_objects.indicat or.gauge.axis.Tickformatstop instances or dicts with compatible properties

    tickformatstopdefaults

    When used in a template (as layout.template.dat a.indicator.gauge.axis.tickformatstopdefaults), sets the default property values to use for elements of indicator.gauge.axis.tickformatstops

    ticklen

    Sets the tick length (in px).

    tickmode

    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).

    tickprefix

    Sets a tick label prefix.

    ticks

    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.

    ticksuffix

    Sets a tick label suffix.

    ticktext

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

    ticktextsrc

    Sets the source reference on Chart Studio Cloud for ticktext .

    tickvals

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

    tickvalssrc

    Sets the source reference on Chart Studio Cloud for tickvals .

    tickwidth

    Sets the tick width (in px).

    visible

    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

Returns

Return type

plotly.graph_objects.indicator.gauge.Axis

property bar

Set the appearance of the gauge’s value

The ‘bar’ property is an instance of Bar that may be specified as:

  • An instance of plotly.graph_objects.indicator.gauge.Bar

  • A dict of string/value properties that will be passed to the Bar constructor

    Supported dict properties:

    color

    Sets the background color of the arc.

    line

    plotly.graph_objects.indicator.gauge.ba r.Line instance or dict with compatible properties

    thickness

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

Returns

Return type

plotly.graph_objects.indicator.gauge.Bar

property bgcolor

Sets the gauge background color.

The ‘bgcolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns

Return type

str

property bordercolor

Sets the color of the border enclosing the gauge.

The ‘bordercolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns

Return type

str

property borderwidth

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

The ‘borderwidth’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property shape

Set the shape of the gauge

The ‘shape’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘angular’, ‘bullet’]

Returns

Return type

Any

property stepdefaults

When used in a template (as layout.template.data.indicator.gauge.stepdefaults), sets the default property values to use for elements of indicator.gauge.steps

The ‘stepdefaults’ property is an instance of Step that may be specified as:

Returns

Return type

plotly.graph_objects.indicator.gauge.Step

property steps

The ‘steps’ property is a tuple of instances of Step that may be specified as:

  • A list or tuple of instances of plotly.graph_objects.indicator.gauge.Step

  • A list or tuple of dicts of string/value properties that will be passed to the Step constructor

    Supported dict properties:

    color

    Sets the background color of the arc.

    line

    plotly.graph_objects.indicator.gauge.st ep.Line instance or dict with compatible properties

    name

    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.

    range

    Sets the range of this axis.

    templateitemname

    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.

    thickness

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

Returns

Return type

tuple[plotly.graph_objects.indicator.gauge.Step]

property threshold

The ‘threshold’ property is an instance of Threshold that may be specified as:

  • An instance of plotly.graph_objects.indicator.gauge.Threshold

  • A dict of string/value properties that will be passed to the Threshold constructor

    Supported dict properties:

    line

    plotly.graph_objects.indicator.gauge.th reshold.Line instance or dict with compatible properties

    thickness

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

    value

    Sets a treshold value drawn as a line.

Returns

Return type

plotly.graph_objects.indicator.gauge.Threshold

class plotly.graph_objects.indicator.Number(arg=None, font=None, prefix=None, suffix=None, valueformat=None, **kwargs)
property font

Set the font used to display main number

The ‘font’ property is an instance of Font that may be specified as:

  • An instance of plotly.graph_objects.indicator.number.Font

  • A dict of string/value properties that will be passed to the Font constructor

    Supported dict properties:

    color

    family

    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

Returns

Return type

plotly.graph_objects.indicator.number.Font

property prefix

Sets a prefix appearing before the number.

The ‘prefix’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str

property suffix

Sets a suffix appearing next to the number.

The ‘suffix’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str

property valueformat

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

The ‘valueformat’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str

class plotly.graph_objects.indicator.Stream(arg=None, maxpoints=None, token=None, **kwargs)
property maxpoints

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

The ‘maxpoints’ property is a number and may be specified as:

  • An int or float in the interval [0, 10000]

Returns

Return type

int|float

property token

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

The ‘token’ property is a string and must be specified as:

  • A non-empty string

Returns

Return type

str

class plotly.graph_objects.indicator.Title(arg=None, align=None, font=None, text=None, **kwargs)
property align

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

The ‘align’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘left’, ‘center’, ‘right’]

Returns

Return type

Any

property font

Set the font used to display the title

The ‘font’ property is an instance of Font that may be specified as:

  • An instance of plotly.graph_objects.indicator.title.Font

  • A dict of string/value properties that will be passed to the Font constructor

    Supported dict properties:

    color

    family

    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

Returns

Return type

plotly.graph_objects.indicator.title.Font

property text

Sets the title of this indicator.

The ‘text’ property is a string and must be specified as:

  • A string

  • A number that will be converted to a string

Returns

Return type

str