plotly.graph_objects.indicator package

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

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property decreasing

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

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:

Returns

Return type

plotly.graph_objects.indicator.delta.Font

property increasing

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

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 prefix

Sets a prefix appearing before the delta.

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 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 suffix

Sets a suffix appearing next to the delta.

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- languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#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)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property axis

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

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:

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: see https://plotly.com/python/css-colors/ for a list

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: see https://plotly.com/python/css-colors/ for a list

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

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:

Returns

Return type

plotly.graph_objects.indicator.gauge.Threshold

class plotly.graph_objects.indicator.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property font

Sets this legend group’s title font.

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

Returns

Return type

plotly.graph_objects.indicator.legendgrouptitle.Font

property text

Sets the title of the legend group.

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

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

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property font

Set the font used to display main number

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

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- languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#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)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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)

Bases: plotly.basedatatypes.BaseTraceHierarchyType

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:

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