849 lines
28 KiB
Python
849 lines
28 KiB
Python
|
# --- THIS FILE IS AUTO-GENERATED ---
|
||
|
|
# Modifications will be overwitten the next time code generation run.
|
||
|
|
|
||
|
|
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
||
|
|
import copy as _copy
|
||
|
|
|
||
|
|
|
||
|
|
class Indicator(_BaseTraceType):
|
||
|
|
_parent_path_str = ""
|
||
|
|
_path_str = "indicator"
|
||
|
|
_valid_props = {
|
||
|
|
"align",
|
||
|
|
"customdata",
|
||
|
|
"customdatasrc",
|
||
|
|
"delta",
|
||
|
|
"domain",
|
||
|
|
"gauge",
|
||
|
|
"ids",
|
||
|
|
"idssrc",
|
||
|
|
"legend",
|
||
|
|
"legendgrouptitle",
|
||
|
|
"legendrank",
|
||
|
|
"legendwidth",
|
||
|
|
"meta",
|
||
|
|
"metasrc",
|
||
|
|
"mode",
|
||
|
|
"name",
|
||
|
|
"number",
|
||
|
|
"stream",
|
||
|
|
"title",
|
||
|
|
"type",
|
||
|
|
"uid",
|
||
|
|
"uirevision",
|
||
|
|
"value",
|
||
|
|
"visible",
|
||
|
|
}
|
||
|
|
|
||
|
|
@property
|
||
|
|
def align(self):
|
||
|
|
"""
|
||
|
|
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
|
||
|
|
|
||
|
|
The 'align' property is an enumeration that may be specified as:
|
||
|
|
- One of the following enumeration values:
|
||
|
|
['left', 'center', 'right']
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
Any
|
||
|
|
"""
|
||
|
|
return self["align"]
|
||
|
|
|
||
|
|
@align.setter
|
||
|
|
def align(self, val):
|
||
|
|
self["align"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def customdata(self):
|
||
|
|
"""
|
||
|
|
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
|
||
|
|
|
||
|
|
The 'customdata' property is an array that may be specified as a tuple,
|
||
|
|
list, numpy array, or pandas Series
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
numpy.ndarray
|
||
|
|
"""
|
||
|
|
return self["customdata"]
|
||
|
|
|
||
|
|
@customdata.setter
|
||
|
|
def customdata(self, val):
|
||
|
|
self["customdata"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def customdatasrc(self):
|
||
|
|
"""
|
||
|
|
Sets the source reference on Chart Studio Cloud for
|
||
|
|
`customdata`.
|
||
|
|
|
||
|
|
The 'customdatasrc' property must be specified as a string or
|
||
|
|
as a plotly.grid_objs.Column object
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
str
|
||
|
|
"""
|
||
|
|
return self["customdatasrc"]
|
||
|
|
|
||
|
|
@customdatasrc.setter
|
||
|
|
def customdatasrc(self, val):
|
||
|
|
self["customdatasrc"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def delta(self):
|
||
|
|
"""
|
||
|
|
The 'delta' property is an instance of Delta
|
||
|
|
that may be specified as:
|
||
|
|
- An instance of :class:`plotly.graph_objs.indicator.Delta`
|
||
|
|
- A dict of string/value properties that will be passed
|
||
|
|
to the Delta constructor
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
plotly.graph_objs.indicator.Delta
|
||
|
|
"""
|
||
|
|
return self["delta"]
|
||
|
|
|
||
|
|
@delta.setter
|
||
|
|
def delta(self, val):
|
||
|
|
self["delta"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def domain(self):
|
||
|
|
"""
|
||
|
|
The 'domain' property is an instance of Domain
|
||
|
|
that may be specified as:
|
||
|
|
- An instance of :class:`plotly.graph_objs.indicator.Domain`
|
||
|
|
- A dict of string/value properties that will be passed
|
||
|
|
to the Domain constructor
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
plotly.graph_objs.indicator.Domain
|
||
|
|
"""
|
||
|
|
return self["domain"]
|
||
|
|
|
||
|
|
@domain.setter
|
||
|
|
def domain(self, val):
|
||
|
|
self["domain"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def gauge(self):
|
||
|
|
"""
|
||
|
|
The gauge of the Indicator plot.
|
||
|
|
|
||
|
|
The 'gauge' property is an instance of Gauge
|
||
|
|
that may be specified as:
|
||
|
|
- An instance of :class:`plotly.graph_objs.indicator.Gauge`
|
||
|
|
- A dict of string/value properties that will be passed
|
||
|
|
to the Gauge constructor
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
plotly.graph_objs.indicator.Gauge
|
||
|
|
"""
|
||
|
|
return self["gauge"]
|
||
|
|
|
||
|
|
@gauge.setter
|
||
|
|
def gauge(self, val):
|
||
|
|
self["gauge"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def ids(self):
|
||
|
|
"""
|
||
|
|
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.
|
||
|
|
|
||
|
|
The 'ids' property is an array that may be specified as a tuple,
|
||
|
|
list, numpy array, or pandas Series
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
numpy.ndarray
|
||
|
|
"""
|
||
|
|
return self["ids"]
|
||
|
|
|
||
|
|
@ids.setter
|
||
|
|
def ids(self, val):
|
||
|
|
self["ids"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def idssrc(self):
|
||
|
|
"""
|
||
|
|
Sets the source reference on Chart Studio Cloud for `ids`.
|
||
|
|
|
||
|
|
The 'idssrc' property must be specified as a string or
|
||
|
|
as a plotly.grid_objs.Column object
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
str
|
||
|
|
"""
|
||
|
|
return self["idssrc"]
|
||
|
|
|
||
|
|
@idssrc.setter
|
||
|
|
def idssrc(self, val):
|
||
|
|
self["idssrc"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def legend(self):
|
||
|
|
"""
|
||
|
|
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.
|
||
|
|
|
||
|
|
The 'legend' property is an identifier of a particular
|
||
|
|
subplot, of type 'legend', that may be specified as the string 'legend'
|
||
|
|
optionally followed by an integer >= 1
|
||
|
|
(e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
str
|
||
|
|
"""
|
||
|
|
return self["legend"]
|
||
|
|
|
||
|
|
@legend.setter
|
||
|
|
def legend(self, val):
|
||
|
|
self["legend"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def legendgrouptitle(self):
|
||
|
|
"""
|
||
|
|
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
||
|
|
that may be specified as:
|
||
|
|
- An instance of :class:`plotly.graph_objs.indicator.Legendgrouptitle`
|
||
|
|
- A dict of string/value properties that will be passed
|
||
|
|
to the Legendgrouptitle constructor
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
plotly.graph_objs.indicator.Legendgrouptitle
|
||
|
|
"""
|
||
|
|
return self["legendgrouptitle"]
|
||
|
|
|
||
|
|
@legendgrouptitle.setter
|
||
|
|
def legendgrouptitle(self, val):
|
||
|
|
self["legendgrouptitle"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def legendrank(self):
|
||
|
|
"""
|
||
|
|
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.
|
||
|
|
|
||
|
|
The 'legendrank' property is a number and may be specified as:
|
||
|
|
- An int or float
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
int|float
|
||
|
|
"""
|
||
|
|
return self["legendrank"]
|
||
|
|
|
||
|
|
@legendrank.setter
|
||
|
|
def legendrank(self, val):
|
||
|
|
self["legendrank"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def legendwidth(self):
|
||
|
|
"""
|
||
|
|
Sets the width (in px or fraction) of the legend for this
|
||
|
|
trace.
|
||
|
|
|
||
|
|
The 'legendwidth' property is a number and may be specified as:
|
||
|
|
- An int or float in the interval [0, inf]
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
int|float
|
||
|
|
"""
|
||
|
|
return self["legendwidth"]
|
||
|
|
|
||
|
|
@legendwidth.setter
|
||
|
|
def legendwidth(self, val):
|
||
|
|
self["legendwidth"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def meta(self):
|
||
|
|
"""
|
||
|
|
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.
|
||
|
|
|
||
|
|
The 'meta' property accepts values of any type
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
Any|numpy.ndarray
|
||
|
|
"""
|
||
|
|
return self["meta"]
|
||
|
|
|
||
|
|
@meta.setter
|
||
|
|
def meta(self, val):
|
||
|
|
self["meta"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def metasrc(self):
|
||
|
|
"""
|
||
|
|
Sets the source reference on Chart Studio Cloud for `meta`.
|
||
|
|
|
||
|
|
The 'metasrc' property must be specified as a string or
|
||
|
|
as a plotly.grid_objs.Column object
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
str
|
||
|
|
"""
|
||
|
|
return self["metasrc"]
|
||
|
|
|
||
|
|
@metasrc.setter
|
||
|
|
def metasrc(self, val):
|
||
|
|
self["metasrc"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def mode(self):
|
||
|
|
"""
|
||
|
|
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.
|
||
|
|
|
||
|
|
The 'mode' property is a flaglist and may be specified
|
||
|
|
as a string containing:
|
||
|
|
- Any combination of ['number', 'delta', 'gauge'] joined with '+' characters
|
||
|
|
(e.g. 'number+delta')
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
Any
|
||
|
|
"""
|
||
|
|
return self["mode"]
|
||
|
|
|
||
|
|
@mode.setter
|
||
|
|
def mode(self, val):
|
||
|
|
self["mode"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def name(self):
|
||
|
|
"""
|
||
|
|
Sets the trace name. The trace name appears as the legend item
|
||
|
|
and on hover.
|
||
|
|
|
||
|
|
The 'name' property is a string and must be specified as:
|
||
|
|
- A string
|
||
|
|
- A number that will be converted to a string
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
str
|
||
|
|
"""
|
||
|
|
return self["name"]
|
||
|
|
|
||
|
|
@name.setter
|
||
|
|
def name(self, val):
|
||
|
|
self["name"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def number(self):
|
||
|
|
"""
|
||
|
|
The 'number' property is an instance of Number
|
||
|
|
that may be specified as:
|
||
|
|
- An instance of :class:`plotly.graph_objs.indicator.Number`
|
||
|
|
- A dict of string/value properties that will be passed
|
||
|
|
to the Number constructor
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
plotly.graph_objs.indicator.Number
|
||
|
|
"""
|
||
|
|
return self["number"]
|
||
|
|
|
||
|
|
@number.setter
|
||
|
|
def number(self, val):
|
||
|
|
self["number"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def stream(self):
|
||
|
|
"""
|
||
|
|
The 'stream' property is an instance of Stream
|
||
|
|
that may be specified as:
|
||
|
|
- An instance of :class:`plotly.graph_objs.indicator.Stream`
|
||
|
|
- A dict of string/value properties that will be passed
|
||
|
|
to the Stream constructor
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
plotly.graph_objs.indicator.Stream
|
||
|
|
"""
|
||
|
|
return self["stream"]
|
||
|
|
|
||
|
|
@stream.setter
|
||
|
|
def stream(self, val):
|
||
|
|
self["stream"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def title(self):
|
||
|
|
"""
|
||
|
|
The 'title' property is an instance of Title
|
||
|
|
that may be specified as:
|
||
|
|
- An instance of :class:`plotly.graph_objs.indicator.Title`
|
||
|
|
- A dict of string/value properties that will be passed
|
||
|
|
to the Title constructor
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
plotly.graph_objs.indicator.Title
|
||
|
|
"""
|
||
|
|
return self["title"]
|
||
|
|
|
||
|
|
@title.setter
|
||
|
|
def title(self, val):
|
||
|
|
self["title"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def uid(self):
|
||
|
|
"""
|
||
|
|
Assign an id to this trace, Use this to provide object
|
||
|
|
constancy between traces during animations and transitions.
|
||
|
|
|
||
|
|
The 'uid' property is a string and must be specified as:
|
||
|
|
- A string
|
||
|
|
- A number that will be converted to a string
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
str
|
||
|
|
"""
|
||
|
|
return self["uid"]
|
||
|
|
|
||
|
|
@uid.setter
|
||
|
|
def uid(self, val):
|
||
|
|
self["uid"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def uirevision(self):
|
||
|
|
"""
|
||
|
|
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.
|
||
|
|
|
||
|
|
The 'uirevision' property accepts values of any type
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
Any
|
||
|
|
"""
|
||
|
|
return self["uirevision"]
|
||
|
|
|
||
|
|
@uirevision.setter
|
||
|
|
def uirevision(self, val):
|
||
|
|
self["uirevision"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def value(self):
|
||
|
|
"""
|
||
|
|
Sets the number to be displayed.
|
||
|
|
|
||
|
|
The 'value' property is a number and may be specified as:
|
||
|
|
- An int or float
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
int|float
|
||
|
|
"""
|
||
|
|
return self["value"]
|
||
|
|
|
||
|
|
@value.setter
|
||
|
|
def value(self, val):
|
||
|
|
self["value"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def visible(self):
|
||
|
|
"""
|
||
|
|
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).
|
||
|
|
|
||
|
|
The 'visible' property is an enumeration that may be specified as:
|
||
|
|
- One of the following enumeration values:
|
||
|
|
[True, False, 'legendonly']
|
||
|
|
|
||
|
|
Returns
|
||
|
|
-------
|
||
|
|
Any
|
||
|
|
"""
|
||
|
|
return self["visible"]
|
||
|
|
|
||
|
|
@visible.setter
|
||
|
|
def visible(self, val):
|
||
|
|
self["visible"] = val
|
||
|
|
|
||
|
|
@property
|
||
|
|
def type(self):
|
||
|
|
return self._props["type"]
|
||
|
|
|
||
|
|
@property
|
||
|
|
def _prop_descriptions(self):
|
||
|
|
return """\
|
||
|
|
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
|
||
|
|
:class:`plotly.graph_objects.indicator.Delta` instance
|
||
|
|
or dict with compatible properties
|
||
|
|
domain
|
||
|
|
:class:`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`.
|
||
|
|
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.
|
||
|
|
legendgrouptitle
|
||
|
|
:class:`plotly.graph_objects.indicator.Legendgrouptitle
|
||
|
|
` instance or dict with compatible properties
|
||
|
|
legendrank
|
||
|
|
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.
|
||
|
|
legendwidth
|
||
|
|
Sets the width (in px or fraction) of the legend for
|
||
|
|
this trace.
|
||
|
|
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 appears as the
|
||
|
|
legend item and on hover.
|
||
|
|
number
|
||
|
|
:class:`plotly.graph_objects.indicator.Number` instance
|
||
|
|
or dict with compatible properties
|
||
|
|
stream
|
||
|
|
:class:`plotly.graph_objects.indicator.Stream` instance
|
||
|
|
or dict with compatible properties
|
||
|
|
title
|
||
|
|
:class:`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).
|
||
|
|
"""
|
||
|
|
|
||
|
|
def __init__(
|
||
|
|
self,
|
||
|
|
arg=None,
|
||
|
|
align=None,
|
||
|
|
customdata=None,
|
||
|
|
customdatasrc=None,
|
||
|
|
delta=None,
|
||
|
|
domain=None,
|
||
|
|
gauge=None,
|
||
|
|
ids=None,
|
||
|
|
idssrc=None,
|
||
|
|
legend=None,
|
||
|
|
legendgrouptitle=None,
|
||
|
|
legendrank=None,
|
||
|
|
legendwidth=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 :class:`plotly.graph_objs.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
|
||
|
|
:class:`plotly.graph_objects.indicator.Delta` instance
|
||
|
|
or dict with compatible properties
|
||
|
|
domain
|
||
|
|
:class:`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`.
|
||
|
|
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.
|
||
|
|
legendgrouptitle
|
||
|
|
:class:`plotly.graph_objects.indicator.Legendgrouptitle
|
||
|
|
` instance or dict with compatible properties
|
||
|
|
legendrank
|
||
|
|
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.
|
||
|
|
legendwidth
|
||
|
|
Sets the width (in px or fraction) of the legend for
|
||
|
|
this trace.
|
||
|
|
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 appears as the
|
||
|
|
legend item and on hover.
|
||
|
|
number
|
||
|
|
:class:`plotly.graph_objects.indicator.Number` instance
|
||
|
|
or dict with compatible properties
|
||
|
|
stream
|
||
|
|
:class:`plotly.graph_objects.indicator.Stream` instance
|
||
|
|
or dict with compatible properties
|
||
|
|
title
|
||
|
|
:class:`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
|
||
|
|
-------
|
||
|
|
Indicator
|
||
|
|
"""
|
||
|
|
super().__init__("indicator")
|
||
|
|
if "_parent" in kwargs:
|
||
|
|
self._parent = kwargs["_parent"]
|
||
|
|
return
|
||
|
|
|
||
|
|
if arg is None:
|
||
|
|
arg = {}
|
||
|
|
elif isinstance(arg, self.__class__):
|
||
|
|
arg = arg.to_plotly_json()
|
||
|
|
elif isinstance(arg, dict):
|
||
|
|
arg = _copy.copy(arg)
|
||
|
|
else:
|
||
|
|
raise ValueError("""\
|
||
|
|
The first argument to the plotly.graph_objs.Indicator
|
||
|
|
constructor must be a dict or
|
||
|
|
an instance of :class:`plotly.graph_objs.Indicator`""")
|
||
|
|
|
||
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||
|
|
self._validate = kwargs.pop("_validate", True)
|
||
|
|
|
||
|
|
self._set_property("align", arg, align)
|
||
|
|
self._set_property("customdata", arg, customdata)
|
||
|
|
self._set_property("customdatasrc", arg, customdatasrc)
|
||
|
|
self._set_property("delta", arg, delta)
|
||
|
|
self._set_property("domain", arg, domain)
|
||
|
|
self._set_property("gauge", arg, gauge)
|
||
|
|
self._set_property("ids", arg, ids)
|
||
|
|
self._set_property("idssrc", arg, idssrc)
|
||
|
|
self._set_property("legend", arg, legend)
|
||
|
|
self._set_property("legendgrouptitle", arg, legendgrouptitle)
|
||
|
|
self._set_property("legendrank", arg, legendrank)
|
||
|
|
self._set_property("legendwidth", arg, legendwidth)
|
||
|
|
self._set_property("meta", arg, meta)
|
||
|
|
self._set_property("metasrc", arg, metasrc)
|
||
|
|
self._set_property("mode", arg, mode)
|
||
|
|
self._set_property("name", arg, name)
|
||
|
|
self._set_property("number", arg, number)
|
||
|
|
self._set_property("stream", arg, stream)
|
||
|
|
self._set_property("title", arg, title)
|
||
|
|
self._set_property("uid", arg, uid)
|
||
|
|
self._set_property("uirevision", arg, uirevision)
|
||
|
|
self._set_property("value", arg, value)
|
||
|
|
self._set_property("visible", arg, visible)
|
||
|
|
|
||
|
|
self._props["type"] = "indicator"
|
||
|
|
arg.pop("type", None)
|
||
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
||
|
|
self._skip_invalid = False
|