2583 lines
88 KiB
Python
2583 lines
88 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 Waterfall(_BaseTraceType):
|
|
_parent_path_str = ""
|
|
_path_str = "waterfall"
|
|
_valid_props = {
|
|
"alignmentgroup",
|
|
"base",
|
|
"cliponaxis",
|
|
"connector",
|
|
"constraintext",
|
|
"customdata",
|
|
"customdatasrc",
|
|
"decreasing",
|
|
"dx",
|
|
"dy",
|
|
"hoverinfo",
|
|
"hoverinfosrc",
|
|
"hoverlabel",
|
|
"hovertemplate",
|
|
"hovertemplatesrc",
|
|
"hovertext",
|
|
"hovertextsrc",
|
|
"ids",
|
|
"idssrc",
|
|
"increasing",
|
|
"insidetextanchor",
|
|
"insidetextfont",
|
|
"legend",
|
|
"legendgroup",
|
|
"legendgrouptitle",
|
|
"legendrank",
|
|
"legendwidth",
|
|
"measure",
|
|
"measuresrc",
|
|
"meta",
|
|
"metasrc",
|
|
"name",
|
|
"offset",
|
|
"offsetgroup",
|
|
"offsetsrc",
|
|
"opacity",
|
|
"orientation",
|
|
"outsidetextfont",
|
|
"selectedpoints",
|
|
"showlegend",
|
|
"stream",
|
|
"text",
|
|
"textangle",
|
|
"textfont",
|
|
"textinfo",
|
|
"textposition",
|
|
"textpositionsrc",
|
|
"textsrc",
|
|
"texttemplate",
|
|
"texttemplatesrc",
|
|
"totals",
|
|
"type",
|
|
"uid",
|
|
"uirevision",
|
|
"visible",
|
|
"width",
|
|
"widthsrc",
|
|
"x",
|
|
"x0",
|
|
"xaxis",
|
|
"xhoverformat",
|
|
"xperiod",
|
|
"xperiod0",
|
|
"xperiodalignment",
|
|
"xsrc",
|
|
"y",
|
|
"y0",
|
|
"yaxis",
|
|
"yhoverformat",
|
|
"yperiod",
|
|
"yperiod0",
|
|
"yperiodalignment",
|
|
"ysrc",
|
|
"zorder",
|
|
}
|
|
|
|
@property
|
|
def alignmentgroup(self):
|
|
"""
|
|
Set several traces linked to the same position axis or matching
|
|
axes to the same alignmentgroup. This controls whether bars
|
|
compute their positional range dependently or independently.
|
|
|
|
The 'alignmentgroup' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["alignmentgroup"]
|
|
|
|
@alignmentgroup.setter
|
|
def alignmentgroup(self, val):
|
|
self["alignmentgroup"] = val
|
|
|
|
@property
|
|
def base(self):
|
|
"""
|
|
Sets where the bar base is drawn (in position axis units).
|
|
|
|
The 'base' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["base"]
|
|
|
|
@base.setter
|
|
def base(self, val):
|
|
self["base"] = val
|
|
|
|
@property
|
|
def cliponaxis(self):
|
|
"""
|
|
Determines whether the text nodes are clipped about the subplot
|
|
axes. To show the text nodes above axis lines and tick labels,
|
|
make sure to set `xaxis.layer` and `yaxis.layer` to *below
|
|
traces*.
|
|
|
|
The 'cliponaxis' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["cliponaxis"]
|
|
|
|
@cliponaxis.setter
|
|
def cliponaxis(self, val):
|
|
self["cliponaxis"] = val
|
|
|
|
@property
|
|
def connector(self):
|
|
"""
|
|
The 'connector' property is an instance of Connector
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.waterfall.Connector`
|
|
- A dict of string/value properties that will be passed
|
|
to the Connector constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Connector
|
|
"""
|
|
return self["connector"]
|
|
|
|
@connector.setter
|
|
def connector(self, val):
|
|
self["connector"] = val
|
|
|
|
@property
|
|
def constraintext(self):
|
|
"""
|
|
Constrain the size of text inside or outside a bar to be no
|
|
larger than the bar itself.
|
|
|
|
The 'constraintext' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['inside', 'outside', 'both', 'none']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["constraintext"]
|
|
|
|
@constraintext.setter
|
|
def constraintext(self, val):
|
|
self["constraintext"] = 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 decreasing(self):
|
|
"""
|
|
The 'decreasing' property is an instance of Decreasing
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.waterfall.Decreasing`
|
|
- A dict of string/value properties that will be passed
|
|
to the Decreasing constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Decreasing
|
|
"""
|
|
return self["decreasing"]
|
|
|
|
@decreasing.setter
|
|
def decreasing(self, val):
|
|
self["decreasing"] = val
|
|
|
|
@property
|
|
def dx(self):
|
|
"""
|
|
Sets the x coordinate step. See `x0` for more info.
|
|
|
|
The 'dx' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["dx"]
|
|
|
|
@dx.setter
|
|
def dx(self, val):
|
|
self["dx"] = val
|
|
|
|
@property
|
|
def dy(self):
|
|
"""
|
|
Sets the y coordinate step. See `y0` for more info.
|
|
|
|
The 'dy' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["dy"]
|
|
|
|
@dy.setter
|
|
def dy(self, val):
|
|
self["dy"] = val
|
|
|
|
@property
|
|
def hoverinfo(self):
|
|
"""
|
|
Determines which trace information appear on hover. If `none`
|
|
or `skip` are set, no information is displayed upon hovering.
|
|
But, if `none` is set, click and hover events are still fired.
|
|
|
|
The 'hoverinfo' property is a flaglist and may be specified
|
|
as a string containing:
|
|
- Any combination of ['name', 'x', 'y', 'text', 'initial', 'delta', 'final'] joined with '+' characters
|
|
(e.g. 'name+x')
|
|
OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
|
- A list or array of the above
|
|
|
|
Returns
|
|
-------
|
|
Any|numpy.ndarray
|
|
"""
|
|
return self["hoverinfo"]
|
|
|
|
@hoverinfo.setter
|
|
def hoverinfo(self, val):
|
|
self["hoverinfo"] = val
|
|
|
|
@property
|
|
def hoverinfosrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hoverinfo`.
|
|
|
|
The 'hoverinfosrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["hoverinfosrc"]
|
|
|
|
@hoverinfosrc.setter
|
|
def hoverinfosrc(self, val):
|
|
self["hoverinfosrc"] = val
|
|
|
|
@property
|
|
def hoverlabel(self):
|
|
"""
|
|
The 'hoverlabel' property is an instance of Hoverlabel
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.waterfall.Hoverlabel`
|
|
- A dict of string/value properties that will be passed
|
|
to the Hoverlabel constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Hoverlabel
|
|
"""
|
|
return self["hoverlabel"]
|
|
|
|
@hoverlabel.setter
|
|
def hoverlabel(self, val):
|
|
self["hoverlabel"] = val
|
|
|
|
@property
|
|
def hovertemplate(self):
|
|
"""
|
|
Template string used for rendering the information that appear
|
|
on hover box. Note that this will override `hoverinfo`.
|
|
Variables are inserted using %{variable}, for example "y: %{y}"
|
|
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
|
|
showing info for several points, "xother" will be added to
|
|
those with different x positions from the first point. An
|
|
underscore before or after "(x|y)other" will add a space on
|
|
that side, only when this field is shown. Numbers are formatted
|
|
using d3-format's syntax %{variable:d3-format}, for example
|
|
"Price: %{y:$.2f}".
|
|
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
|
|
details on the formatting syntax. Dates are formatted using
|
|
d3-time-format's syntax %{variable|d3-time-format}, for example
|
|
"Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format for details on the date
|
|
formatting syntax. The variables available in `hovertemplate`
|
|
are the ones emitted as event data described at this link
|
|
https://plotly.com/javascript/plotlyjs-events/#event-data.
|
|
Additionally, every attributes that can be specified per-point
|
|
(the ones that are `arrayOk: true`) are available. Finally, the
|
|
template string has access to variables `initial`, `delta` and
|
|
`final`. Anything contained in tag `<extra>` is displayed in
|
|
the secondary box, for example
|
|
`<extra>%{fullData.name}</extra>`. To hide the secondary box
|
|
completely, use an empty tag `<extra></extra>`.
|
|
|
|
The 'hovertemplate' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
str|numpy.ndarray
|
|
"""
|
|
return self["hovertemplate"]
|
|
|
|
@hovertemplate.setter
|
|
def hovertemplate(self, val):
|
|
self["hovertemplate"] = val
|
|
|
|
@property
|
|
def hovertemplatesrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertemplate`.
|
|
|
|
The 'hovertemplatesrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["hovertemplatesrc"]
|
|
|
|
@hovertemplatesrc.setter
|
|
def hovertemplatesrc(self, val):
|
|
self["hovertemplatesrc"] = val
|
|
|
|
@property
|
|
def hovertext(self):
|
|
"""
|
|
Sets hover text elements associated with each (x,y) pair. If a
|
|
single string, the same string appears over all the data
|
|
points. If an array of string, the items are mapped in order to
|
|
the this trace's (x,y) coordinates. To be seen, trace
|
|
`hoverinfo` must contain a "text" flag.
|
|
|
|
The 'hovertext' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
str|numpy.ndarray
|
|
"""
|
|
return self["hovertext"]
|
|
|
|
@hovertext.setter
|
|
def hovertext(self, val):
|
|
self["hovertext"] = val
|
|
|
|
@property
|
|
def hovertextsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertext`.
|
|
|
|
The 'hovertextsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["hovertextsrc"]
|
|
|
|
@hovertextsrc.setter
|
|
def hovertextsrc(self, val):
|
|
self["hovertextsrc"] = 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 increasing(self):
|
|
"""
|
|
The 'increasing' property is an instance of Increasing
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.waterfall.Increasing`
|
|
- A dict of string/value properties that will be passed
|
|
to the Increasing constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Increasing
|
|
"""
|
|
return self["increasing"]
|
|
|
|
@increasing.setter
|
|
def increasing(self, val):
|
|
self["increasing"] = val
|
|
|
|
@property
|
|
def insidetextanchor(self):
|
|
"""
|
|
Determines if texts are kept at center or start/end points in
|
|
`textposition` "inside" mode.
|
|
|
|
The 'insidetextanchor' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['end', 'middle', 'start']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["insidetextanchor"]
|
|
|
|
@insidetextanchor.setter
|
|
def insidetextanchor(self, val):
|
|
self["insidetextanchor"] = val
|
|
|
|
@property
|
|
def insidetextfont(self):
|
|
"""
|
|
Sets the font used for `text` lying inside the bar.
|
|
|
|
The 'insidetextfont' property is an instance of Insidetextfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.waterfall.Insidetextfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Insidetextfont constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Insidetextfont
|
|
"""
|
|
return self["insidetextfont"]
|
|
|
|
@insidetextfont.setter
|
|
def insidetextfont(self, val):
|
|
self["insidetextfont"] = 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 legendgroup(self):
|
|
"""
|
|
Sets the legend group for this trace. Traces and shapes part of
|
|
the same legend group hide/show at the same time when toggling
|
|
legend items.
|
|
|
|
The 'legendgroup' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["legendgroup"]
|
|
|
|
@legendgroup.setter
|
|
def legendgroup(self, val):
|
|
self["legendgroup"] = 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.waterfall.Legendgrouptitle`
|
|
- A dict of string/value properties that will be passed
|
|
to the Legendgrouptitle constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.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 measure(self):
|
|
"""
|
|
An array containing types of values. By default the values are
|
|
considered as 'relative'. However; it is possible to use
|
|
'total' to compute the sums. Also 'absolute' could be applied
|
|
to reset the computed total or to declare an initial value
|
|
where needed.
|
|
|
|
The 'measure' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["measure"]
|
|
|
|
@measure.setter
|
|
def measure(self, val):
|
|
self["measure"] = val
|
|
|
|
@property
|
|
def measuresrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `measure`.
|
|
|
|
The 'measuresrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["measuresrc"]
|
|
|
|
@measuresrc.setter
|
|
def measuresrc(self, val):
|
|
self["measuresrc"] = 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 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 offset(self):
|
|
"""
|
|
Shifts the position where the bar is drawn (in position axis
|
|
units). In "group" barmode, traces that set "offset" will be
|
|
excluded and drawn in "overlay" mode instead.
|
|
|
|
The 'offset' property is a number and may be specified as:
|
|
- An int or float
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
int|float|numpy.ndarray
|
|
"""
|
|
return self["offset"]
|
|
|
|
@offset.setter
|
|
def offset(self, val):
|
|
self["offset"] = val
|
|
|
|
@property
|
|
def offsetgroup(self):
|
|
"""
|
|
Set several traces linked to the same position axis or matching
|
|
axes to the same offsetgroup where bars of the same position
|
|
coordinate will line up.
|
|
|
|
The 'offsetgroup' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["offsetgroup"]
|
|
|
|
@offsetgroup.setter
|
|
def offsetgroup(self, val):
|
|
self["offsetgroup"] = val
|
|
|
|
@property
|
|
def offsetsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `offset`.
|
|
|
|
The 'offsetsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["offsetsrc"]
|
|
|
|
@offsetsrc.setter
|
|
def offsetsrc(self, val):
|
|
self["offsetsrc"] = val
|
|
|
|
@property
|
|
def opacity(self):
|
|
"""
|
|
Sets the opacity of the trace.
|
|
|
|
The 'opacity' property is a number and may be specified as:
|
|
- An int or float in the interval [0, 1]
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["opacity"]
|
|
|
|
@opacity.setter
|
|
def opacity(self, val):
|
|
self["opacity"] = val
|
|
|
|
@property
|
|
def orientation(self):
|
|
"""
|
|
Sets the orientation of the bars. With "v" ("h"), the value of
|
|
the each bar spans along the vertical (horizontal).
|
|
|
|
The 'orientation' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['v', 'h']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["orientation"]
|
|
|
|
@orientation.setter
|
|
def orientation(self, val):
|
|
self["orientation"] = val
|
|
|
|
@property
|
|
def outsidetextfont(self):
|
|
"""
|
|
Sets the font used for `text` lying outside the bar.
|
|
|
|
The 'outsidetextfont' property is an instance of Outsidetextfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.waterfall.Outsidetextfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Outsidetextfont constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Outsidetextfont
|
|
"""
|
|
return self["outsidetextfont"]
|
|
|
|
@outsidetextfont.setter
|
|
def outsidetextfont(self, val):
|
|
self["outsidetextfont"] = val
|
|
|
|
@property
|
|
def selectedpoints(self):
|
|
"""
|
|
Array containing integer indices of selected points. Has an
|
|
effect only for traces that support selections. Note that an
|
|
empty array means an empty selection where the `unselected` are
|
|
turned on for all points, whereas, any other non-array values
|
|
means no selection all where the `selected` and `unselected`
|
|
styles have no effect.
|
|
|
|
The 'selectedpoints' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["selectedpoints"]
|
|
|
|
@selectedpoints.setter
|
|
def selectedpoints(self, val):
|
|
self["selectedpoints"] = val
|
|
|
|
@property
|
|
def showlegend(self):
|
|
"""
|
|
Determines whether or not an item corresponding to this trace
|
|
is shown in the legend.
|
|
|
|
The 'showlegend' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["showlegend"]
|
|
|
|
@showlegend.setter
|
|
def showlegend(self, val):
|
|
self["showlegend"] = 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.waterfall.Stream`
|
|
- A dict of string/value properties that will be passed
|
|
to the Stream constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Stream
|
|
"""
|
|
return self["stream"]
|
|
|
|
@stream.setter
|
|
def stream(self, val):
|
|
self["stream"] = val
|
|
|
|
@property
|
|
def text(self):
|
|
"""
|
|
Sets text elements associated with each (x,y) pair. If a single
|
|
string, the same string appears over all the data points. If an
|
|
array of string, the items are mapped in order to the this
|
|
trace's (x,y) coordinates. If trace `hoverinfo` contains a
|
|
"text" flag and "hovertext" is not set, these elements will be
|
|
seen in the hover labels.
|
|
|
|
The 'text' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
str|numpy.ndarray
|
|
"""
|
|
return self["text"]
|
|
|
|
@text.setter
|
|
def text(self, val):
|
|
self["text"] = val
|
|
|
|
@property
|
|
def textangle(self):
|
|
"""
|
|
Sets the angle of the tick labels with respect to the bar. For
|
|
example, a `tickangle` of -90 draws the tick labels vertically.
|
|
With "auto" the texts may automatically be rotated to fit with
|
|
the maximum size in bars.
|
|
|
|
The 'textangle' property is a angle (in degrees) that may be
|
|
specified as a number between -180 and 180.
|
|
Numeric values outside this range are converted to the equivalent value
|
|
(e.g. 270 is converted to -90).
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["textangle"]
|
|
|
|
@textangle.setter
|
|
def textangle(self, val):
|
|
self["textangle"] = val
|
|
|
|
@property
|
|
def textfont(self):
|
|
"""
|
|
Sets the font used for `text`.
|
|
|
|
The 'textfont' property is an instance of Textfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.waterfall.Textfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Textfont constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Textfont
|
|
"""
|
|
return self["textfont"]
|
|
|
|
@textfont.setter
|
|
def textfont(self, val):
|
|
self["textfont"] = val
|
|
|
|
@property
|
|
def textinfo(self):
|
|
"""
|
|
Determines which trace information appear on the graph. In the
|
|
case of having multiple waterfalls, totals are computed
|
|
separately (per trace).
|
|
|
|
The 'textinfo' property is a flaglist and may be specified
|
|
as a string containing:
|
|
- Any combination of ['label', 'text', 'initial', 'delta', 'final'] joined with '+' characters
|
|
(e.g. 'label+text')
|
|
OR exactly one of ['none'] (e.g. 'none')
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["textinfo"]
|
|
|
|
@textinfo.setter
|
|
def textinfo(self, val):
|
|
self["textinfo"] = val
|
|
|
|
@property
|
|
def textposition(self):
|
|
"""
|
|
Specifies the location of the `text`. "inside" positions `text`
|
|
inside, next to the bar end (rotated and scaled if needed).
|
|
"outside" positions `text` outside, next to the bar end (scaled
|
|
if needed), unless there is another bar stacked on this one,
|
|
then the text gets pushed inside. "auto" tries to position
|
|
`text` inside the bar, but if the bar is too small and no bar
|
|
is stacked on this one the text is moved outside. If "none", no
|
|
text appears.
|
|
|
|
The 'textposition' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['inside', 'outside', 'auto', 'none']
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
Any|numpy.ndarray
|
|
"""
|
|
return self["textposition"]
|
|
|
|
@textposition.setter
|
|
def textposition(self, val):
|
|
self["textposition"] = val
|
|
|
|
@property
|
|
def textpositionsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`textposition`.
|
|
|
|
The 'textpositionsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["textpositionsrc"]
|
|
|
|
@textpositionsrc.setter
|
|
def textpositionsrc(self, val):
|
|
self["textpositionsrc"] = val
|
|
|
|
@property
|
|
def textsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `text`.
|
|
|
|
The 'textsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["textsrc"]
|
|
|
|
@textsrc.setter
|
|
def textsrc(self, val):
|
|
self["textsrc"] = val
|
|
|
|
@property
|
|
def texttemplate(self):
|
|
"""
|
|
Template string used for rendering the information text that
|
|
appear on points. Note that this will override `textinfo`.
|
|
Variables are inserted using %{variable}, for example "y:
|
|
%{y}". Numbers are formatted using d3-format's syntax
|
|
%{variable:d3-format}, for example "Price: %{y:$.2f}".
|
|
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
|
|
details on the formatting syntax. Dates are formatted using
|
|
d3-time-format's syntax %{variable|d3-time-format}, for example
|
|
"Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format for details on the date
|
|
formatting syntax. Every attributes that can be specified per-
|
|
point (the ones that are `arrayOk: true`) are available.
|
|
Finally, the template string has access to variables `initial`,
|
|
`delta`, `final` and `label`.
|
|
|
|
The 'texttemplate' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
str|numpy.ndarray
|
|
"""
|
|
return self["texttemplate"]
|
|
|
|
@texttemplate.setter
|
|
def texttemplate(self, val):
|
|
self["texttemplate"] = val
|
|
|
|
@property
|
|
def texttemplatesrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`texttemplate`.
|
|
|
|
The 'texttemplatesrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["texttemplatesrc"]
|
|
|
|
@texttemplatesrc.setter
|
|
def texttemplatesrc(self, val):
|
|
self["texttemplatesrc"] = val
|
|
|
|
@property
|
|
def totals(self):
|
|
"""
|
|
The 'totals' property is an instance of Totals
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.waterfall.Totals`
|
|
- A dict of string/value properties that will be passed
|
|
to the Totals constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.waterfall.Totals
|
|
"""
|
|
return self["totals"]
|
|
|
|
@totals.setter
|
|
def totals(self, val):
|
|
self["totals"] = 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 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 width(self):
|
|
"""
|
|
Sets the bar width (in position axis units).
|
|
|
|
The 'width' property is a number and may be specified as:
|
|
- An int or float in the interval [0, inf]
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
int|float|numpy.ndarray
|
|
"""
|
|
return self["width"]
|
|
|
|
@width.setter
|
|
def width(self, val):
|
|
self["width"] = val
|
|
|
|
@property
|
|
def widthsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `width`.
|
|
|
|
The 'widthsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["widthsrc"]
|
|
|
|
@widthsrc.setter
|
|
def widthsrc(self, val):
|
|
self["widthsrc"] = val
|
|
|
|
@property
|
|
def x(self):
|
|
"""
|
|
Sets the x coordinates.
|
|
|
|
The 'x' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["x"]
|
|
|
|
@x.setter
|
|
def x(self, val):
|
|
self["x"] = val
|
|
|
|
@property
|
|
def x0(self):
|
|
"""
|
|
Alternate to `x`. Builds a linear space of x coordinates. Use
|
|
with `dx` where `x0` is the starting coordinate and `dx` the
|
|
step.
|
|
|
|
The 'x0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["x0"]
|
|
|
|
@x0.setter
|
|
def x0(self, val):
|
|
self["x0"] = val
|
|
|
|
@property
|
|
def xaxis(self):
|
|
"""
|
|
Sets a reference between this trace's x coordinates and a 2D
|
|
cartesian x axis. If "x" (the default value), the x coordinates
|
|
refer to `layout.xaxis`. If "x2", the x coordinates refer to
|
|
`layout.xaxis2`, and so on.
|
|
|
|
The 'xaxis' property is an identifier of a particular
|
|
subplot, of type 'x', that may be specified as the string 'x'
|
|
optionally followed by an integer >= 1
|
|
(e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["xaxis"]
|
|
|
|
@xaxis.setter
|
|
def xaxis(self, val):
|
|
self["xaxis"] = val
|
|
|
|
@property
|
|
def xhoverformat(self):
|
|
"""
|
|
Sets the hover text formatting rulefor `x` 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. And for
|
|
dates see: https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format. We add two items to d3's date
|
|
formatter: "%h" for half of the year as a decimal number as
|
|
well as "%{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*By default the values
|
|
are formatted using `xaxis.hoverformat`.
|
|
|
|
The 'xhoverformat' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["xhoverformat"]
|
|
|
|
@xhoverformat.setter
|
|
def xhoverformat(self, val):
|
|
self["xhoverformat"] = val
|
|
|
|
@property
|
|
def xperiod(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the period
|
|
positioning in milliseconds or "M<n>" on the x axis. Special
|
|
values in the form of "M<n>" could be used to declare the
|
|
number of months. In this case `n` must be a positive integer.
|
|
|
|
The 'xperiod' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["xperiod"]
|
|
|
|
@xperiod.setter
|
|
def xperiod(self, val):
|
|
self["xperiod"] = val
|
|
|
|
@property
|
|
def xperiod0(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the base for
|
|
period positioning in milliseconds or date string on the x0
|
|
axis. When `x0period` is round number of weeks, the `x0period0`
|
|
by default would be on a Sunday i.e. 2000-01-02, otherwise it
|
|
would be at 2000-01-01.
|
|
|
|
The 'xperiod0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["xperiod0"]
|
|
|
|
@xperiod0.setter
|
|
def xperiod0(self, val):
|
|
self["xperiod0"] = val
|
|
|
|
@property
|
|
def xperiodalignment(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the x axis.
|
|
|
|
The 'xperiodalignment' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['start', 'middle', 'end']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["xperiodalignment"]
|
|
|
|
@xperiodalignment.setter
|
|
def xperiodalignment(self, val):
|
|
self["xperiodalignment"] = val
|
|
|
|
@property
|
|
def xsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `x`.
|
|
|
|
The 'xsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["xsrc"]
|
|
|
|
@xsrc.setter
|
|
def xsrc(self, val):
|
|
self["xsrc"] = val
|
|
|
|
@property
|
|
def y(self):
|
|
"""
|
|
Sets the y coordinates.
|
|
|
|
The 'y' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["y"]
|
|
|
|
@y.setter
|
|
def y(self, val):
|
|
self["y"] = val
|
|
|
|
@property
|
|
def y0(self):
|
|
"""
|
|
Alternate to `y`. Builds a linear space of y coordinates. Use
|
|
with `dy` where `y0` is the starting coordinate and `dy` the
|
|
step.
|
|
|
|
The 'y0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["y0"]
|
|
|
|
@y0.setter
|
|
def y0(self, val):
|
|
self["y0"] = val
|
|
|
|
@property
|
|
def yaxis(self):
|
|
"""
|
|
Sets a reference between this trace's y coordinates and a 2D
|
|
cartesian y axis. If "y" (the default value), the y coordinates
|
|
refer to `layout.yaxis`. If "y2", the y coordinates refer to
|
|
`layout.yaxis2`, and so on.
|
|
|
|
The 'yaxis' property is an identifier of a particular
|
|
subplot, of type 'y', that may be specified as the string 'y'
|
|
optionally followed by an integer >= 1
|
|
(e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["yaxis"]
|
|
|
|
@yaxis.setter
|
|
def yaxis(self, val):
|
|
self["yaxis"] = val
|
|
|
|
@property
|
|
def yhoverformat(self):
|
|
"""
|
|
Sets the hover text formatting rulefor `y` 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. And for
|
|
dates see: https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format. We add two items to d3's date
|
|
formatter: "%h" for half of the year as a decimal number as
|
|
well as "%{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*By default the values
|
|
are formatted using `yaxis.hoverformat`.
|
|
|
|
The 'yhoverformat' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["yhoverformat"]
|
|
|
|
@yhoverformat.setter
|
|
def yhoverformat(self, val):
|
|
self["yhoverformat"] = val
|
|
|
|
@property
|
|
def yperiod(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the period
|
|
positioning in milliseconds or "M<n>" on the y axis. Special
|
|
values in the form of "M<n>" could be used to declare the
|
|
number of months. In this case `n` must be a positive integer.
|
|
|
|
The 'yperiod' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["yperiod"]
|
|
|
|
@yperiod.setter
|
|
def yperiod(self, val):
|
|
self["yperiod"] = val
|
|
|
|
@property
|
|
def yperiod0(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the base for
|
|
period positioning in milliseconds or date string on the y0
|
|
axis. When `y0period` is round number of weeks, the `y0period0`
|
|
by default would be on a Sunday i.e. 2000-01-02, otherwise it
|
|
would be at 2000-01-01.
|
|
|
|
The 'yperiod0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["yperiod0"]
|
|
|
|
@yperiod0.setter
|
|
def yperiod0(self, val):
|
|
self["yperiod0"] = val
|
|
|
|
@property
|
|
def yperiodalignment(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the y axis.
|
|
|
|
The 'yperiodalignment' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['start', 'middle', 'end']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["yperiodalignment"]
|
|
|
|
@yperiodalignment.setter
|
|
def yperiodalignment(self, val):
|
|
self["yperiodalignment"] = val
|
|
|
|
@property
|
|
def ysrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `y`.
|
|
|
|
The 'ysrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["ysrc"]
|
|
|
|
@ysrc.setter
|
|
def ysrc(self, val):
|
|
self["ysrc"] = val
|
|
|
|
@property
|
|
def zorder(self):
|
|
"""
|
|
Sets the layer on which this trace is displayed, relative to
|
|
other SVG traces on the same subplot. SVG traces with higher
|
|
`zorder` appear in front of those with lower `zorder`.
|
|
|
|
The 'zorder' property is a integer and may be specified as:
|
|
- An int (or float that will be cast to an int)
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
"""
|
|
return self["zorder"]
|
|
|
|
@zorder.setter
|
|
def zorder(self, val):
|
|
self["zorder"] = val
|
|
|
|
@property
|
|
def type(self):
|
|
return self._props["type"]
|
|
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
alignmentgroup
|
|
Set several traces linked to the same position axis or
|
|
matching axes to the same alignmentgroup. This controls
|
|
whether bars compute their positional range dependently
|
|
or independently.
|
|
base
|
|
Sets where the bar base is drawn (in position axis
|
|
units).
|
|
cliponaxis
|
|
Determines whether the text nodes are clipped about the
|
|
subplot axes. To show the text nodes above axis lines
|
|
and tick labels, make sure to set `xaxis.layer` and
|
|
`yaxis.layer` to *below traces*.
|
|
connector
|
|
:class:`plotly.graph_objects.waterfall.Connector`
|
|
instance or dict with compatible properties
|
|
constraintext
|
|
Constrain the size of text inside or outside a bar to
|
|
be no larger than the bar itself.
|
|
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`.
|
|
decreasing
|
|
:class:`plotly.graph_objects.waterfall.Decreasing`
|
|
instance or dict with compatible properties
|
|
dx
|
|
Sets the x coordinate step. See `x0` for more info.
|
|
dy
|
|
Sets the y coordinate step. See `y0` for more info.
|
|
hoverinfo
|
|
Determines which trace information appear on hover. If
|
|
`none` or `skip` are set, no information is displayed
|
|
upon hovering. But, if `none` is set, click and hover
|
|
events are still fired.
|
|
hoverinfosrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hoverinfo`.
|
|
hoverlabel
|
|
:class:`plotly.graph_objects.waterfall.Hoverlabel`
|
|
instance or dict with compatible properties
|
|
hovertemplate
|
|
Template string used for rendering the information that
|
|
appear on hover box. Note that this will override
|
|
`hoverinfo`. Variables are inserted using %{variable},
|
|
for example "y: %{y}" as well as %{xother}, {%_xother},
|
|
{%_xother_}, {%xother_}. When showing info for several
|
|
points, "xother" will be added to those with different
|
|
x positions from the first point. An underscore before
|
|
or after "(x|y)other" will add a space on that side,
|
|
only when this field is shown. Numbers are formatted
|
|
using d3-format's syntax %{variable:d3-format}, for
|
|
example "Price: %{y:$.2f}".
|
|
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
|
for details on the formatting syntax. Dates are
|
|
formatted using d3-time-format's syntax
|
|
%{variable|d3-time-format}, for example "Day:
|
|
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format for details on the
|
|
date formatting syntax. The variables available in
|
|
`hovertemplate` are the ones emitted as event data
|
|
described at this link
|
|
https://plotly.com/javascript/plotlyjs-events/#event-
|
|
data. Additionally, every attributes that can be
|
|
specified per-point (the ones that are `arrayOk: true`)
|
|
are available. Finally, the template string has access
|
|
to variables `initial`, `delta` and `final`. Anything
|
|
contained in tag `<extra>` is displayed in the
|
|
secondary box, for example
|
|
`<extra>%{fullData.name}</extra>`. To hide the
|
|
secondary box completely, use an empty tag
|
|
`<extra></extra>`.
|
|
hovertemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertemplate`.
|
|
hovertext
|
|
Sets hover text elements associated with each (x,y)
|
|
pair. If a single string, the same string appears over
|
|
all the data points. If an array of string, the items
|
|
are mapped in order to the this trace's (x,y)
|
|
coordinates. To be seen, trace `hoverinfo` must contain
|
|
a "text" flag.
|
|
hovertextsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertext`.
|
|
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`.
|
|
increasing
|
|
:class:`plotly.graph_objects.waterfall.Increasing`
|
|
instance or dict with compatible properties
|
|
insidetextanchor
|
|
Determines if texts are kept at center or start/end
|
|
points in `textposition` "inside" mode.
|
|
insidetextfont
|
|
Sets the font used for `text` lying inside the bar.
|
|
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.
|
|
legendgroup
|
|
Sets the legend group for this trace. Traces and shapes
|
|
part of the same legend group hide/show at the same
|
|
time when toggling legend items.
|
|
legendgrouptitle
|
|
:class:`plotly.graph_objects.waterfall.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.
|
|
measure
|
|
An array containing types of values. By default the
|
|
values are considered as 'relative'. However; it is
|
|
possible to use 'total' to compute the sums. Also
|
|
'absolute' could be applied to reset the computed total
|
|
or to declare an initial value where needed.
|
|
measuresrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`measure`.
|
|
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`.
|
|
name
|
|
Sets the trace name. The trace name appears as the
|
|
legend item and on hover.
|
|
offset
|
|
Shifts the position where the bar is drawn (in position
|
|
axis units). In "group" barmode, traces that set
|
|
"offset" will be excluded and drawn in "overlay" mode
|
|
instead.
|
|
offsetgroup
|
|
Set several traces linked to the same position axis or
|
|
matching axes to the same offsetgroup where bars of the
|
|
same position coordinate will line up.
|
|
offsetsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`offset`.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
orientation
|
|
Sets the orientation of the bars. With "v" ("h"), the
|
|
value of the each bar spans along the vertical
|
|
(horizontal).
|
|
outsidetextfont
|
|
Sets the font used for `text` lying outside the bar.
|
|
selectedpoints
|
|
Array containing integer indices of selected points.
|
|
Has an effect only for traces that support selections.
|
|
Note that an empty array means an empty selection where
|
|
the `unselected` are turned on for all points, whereas,
|
|
any other non-array values means no selection all where
|
|
the `selected` and `unselected` styles have no effect.
|
|
showlegend
|
|
Determines whether or not an item corresponding to this
|
|
trace is shown in the legend.
|
|
stream
|
|
:class:`plotly.graph_objects.waterfall.Stream` instance
|
|
or dict with compatible properties
|
|
text
|
|
Sets text elements associated with each (x,y) pair. If
|
|
a single string, the same string appears over all the
|
|
data points. If an array of string, the items are
|
|
mapped in order to the this trace's (x,y) coordinates.
|
|
If trace `hoverinfo` contains a "text" flag and
|
|
"hovertext" is not set, these elements will be seen in
|
|
the hover labels.
|
|
textangle
|
|
Sets the angle of the tick labels with respect to the
|
|
bar. For example, a `tickangle` of -90 draws the tick
|
|
labels vertically. With "auto" the texts may
|
|
automatically be rotated to fit with the maximum size
|
|
in bars.
|
|
textfont
|
|
Sets the font used for `text`.
|
|
textinfo
|
|
Determines which trace information appear on the graph.
|
|
In the case of having multiple waterfalls, totals are
|
|
computed separately (per trace).
|
|
textposition
|
|
Specifies the location of the `text`. "inside"
|
|
positions `text` inside, next to the bar end (rotated
|
|
and scaled if needed). "outside" positions `text`
|
|
outside, next to the bar end (scaled if needed), unless
|
|
there is another bar stacked on this one, then the text
|
|
gets pushed inside. "auto" tries to position `text`
|
|
inside the bar, but if the bar is too small and no bar
|
|
is stacked on this one the text is moved outside. If
|
|
"none", no text appears.
|
|
textpositionsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`textposition`.
|
|
textsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`text`.
|
|
texttemplate
|
|
Template string used for rendering the information text
|
|
that appear on points. Note that this will override
|
|
`textinfo`. Variables are inserted using %{variable},
|
|
for example "y: %{y}". Numbers are formatted using
|
|
d3-format's syntax %{variable:d3-format}, for example
|
|
"Price: %{y:$.2f}".
|
|
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
|
for details on the formatting syntax. Dates are
|
|
formatted using d3-time-format's syntax
|
|
%{variable|d3-time-format}, for example "Day:
|
|
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format for details on the
|
|
date formatting syntax. Every attributes that can be
|
|
specified per-point (the ones that are `arrayOk: true`)
|
|
are available. Finally, the template string has access
|
|
to variables `initial`, `delta`, `final` and `label`.
|
|
texttemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`texttemplate`.
|
|
totals
|
|
:class:`plotly.graph_objects.waterfall.Totals` 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.
|
|
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).
|
|
width
|
|
Sets the bar width (in position axis units).
|
|
widthsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`width`.
|
|
x
|
|
Sets the x coordinates.
|
|
x0
|
|
Alternate to `x`. Builds a linear space of x
|
|
coordinates. Use with `dx` where `x0` is the starting
|
|
coordinate and `dx` the step.
|
|
xaxis
|
|
Sets a reference between this trace's x coordinates and
|
|
a 2D cartesian x axis. If "x" (the default value), the
|
|
x coordinates refer to `layout.xaxis`. If "x2", the x
|
|
coordinates refer to `layout.xaxis2`, and so on.
|
|
xhoverformat
|
|
Sets the hover text formatting rulefor `x` 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.
|
|
And for dates see: https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format. We add two items to
|
|
d3's date formatter: "%h" for half of the year as a
|
|
decimal number as well as "%{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*By default the values are
|
|
formatted using `xaxis.hoverformat`.
|
|
xperiod
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
period positioning in milliseconds or "M<n>" on the x
|
|
axis. Special values in the form of "M<n>" could be
|
|
used to declare the number of months. In this case `n`
|
|
must be a positive integer.
|
|
xperiod0
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
base for period positioning in milliseconds or date
|
|
string on the x0 axis. When `x0period` is round number
|
|
of weeks, the `x0period0` by default would be on a
|
|
Sunday i.e. 2000-01-02, otherwise it would be at
|
|
2000-01-01.
|
|
xperiodalignment
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the x axis.
|
|
xsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`x`.
|
|
y
|
|
Sets the y coordinates.
|
|
y0
|
|
Alternate to `y`. Builds a linear space of y
|
|
coordinates. Use with `dy` where `y0` is the starting
|
|
coordinate and `dy` the step.
|
|
yaxis
|
|
Sets a reference between this trace's y coordinates and
|
|
a 2D cartesian y axis. If "y" (the default value), the
|
|
y coordinates refer to `layout.yaxis`. If "y2", the y
|
|
coordinates refer to `layout.yaxis2`, and so on.
|
|
yhoverformat
|
|
Sets the hover text formatting rulefor `y` 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.
|
|
And for dates see: https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format. We add two items to
|
|
d3's date formatter: "%h" for half of the year as a
|
|
decimal number as well as "%{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*By default the values are
|
|
formatted using `yaxis.hoverformat`.
|
|
yperiod
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
period positioning in milliseconds or "M<n>" on the y
|
|
axis. Special values in the form of "M<n>" could be
|
|
used to declare the number of months. In this case `n`
|
|
must be a positive integer.
|
|
yperiod0
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
base for period positioning in milliseconds or date
|
|
string on the y0 axis. When `y0period` is round number
|
|
of weeks, the `y0period0` by default would be on a
|
|
Sunday i.e. 2000-01-02, otherwise it would be at
|
|
2000-01-01.
|
|
yperiodalignment
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the y axis.
|
|
ysrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`y`.
|
|
zorder
|
|
Sets the layer on which this trace is displayed,
|
|
relative to other SVG traces on the same subplot. SVG
|
|
traces with higher `zorder` appear in front of those
|
|
with lower `zorder`.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
arg=None,
|
|
alignmentgroup=None,
|
|
base=None,
|
|
cliponaxis=None,
|
|
connector=None,
|
|
constraintext=None,
|
|
customdata=None,
|
|
customdatasrc=None,
|
|
decreasing=None,
|
|
dx=None,
|
|
dy=None,
|
|
hoverinfo=None,
|
|
hoverinfosrc=None,
|
|
hoverlabel=None,
|
|
hovertemplate=None,
|
|
hovertemplatesrc=None,
|
|
hovertext=None,
|
|
hovertextsrc=None,
|
|
ids=None,
|
|
idssrc=None,
|
|
increasing=None,
|
|
insidetextanchor=None,
|
|
insidetextfont=None,
|
|
legend=None,
|
|
legendgroup=None,
|
|
legendgrouptitle=None,
|
|
legendrank=None,
|
|
legendwidth=None,
|
|
measure=None,
|
|
measuresrc=None,
|
|
meta=None,
|
|
metasrc=None,
|
|
name=None,
|
|
offset=None,
|
|
offsetgroup=None,
|
|
offsetsrc=None,
|
|
opacity=None,
|
|
orientation=None,
|
|
outsidetextfont=None,
|
|
selectedpoints=None,
|
|
showlegend=None,
|
|
stream=None,
|
|
text=None,
|
|
textangle=None,
|
|
textfont=None,
|
|
textinfo=None,
|
|
textposition=None,
|
|
textpositionsrc=None,
|
|
textsrc=None,
|
|
texttemplate=None,
|
|
texttemplatesrc=None,
|
|
totals=None,
|
|
uid=None,
|
|
uirevision=None,
|
|
visible=None,
|
|
width=None,
|
|
widthsrc=None,
|
|
x=None,
|
|
x0=None,
|
|
xaxis=None,
|
|
xhoverformat=None,
|
|
xperiod=None,
|
|
xperiod0=None,
|
|
xperiodalignment=None,
|
|
xsrc=None,
|
|
y=None,
|
|
y0=None,
|
|
yaxis=None,
|
|
yhoverformat=None,
|
|
yperiod=None,
|
|
yperiod0=None,
|
|
yperiodalignment=None,
|
|
ysrc=None,
|
|
zorder=None,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
Construct a new Waterfall object
|
|
|
|
Draws waterfall trace which is useful graph to displays the
|
|
contribution of various elements (either positive or negative)
|
|
in a bar chart. The data visualized by the span of the bars is
|
|
set in `y` if `orientation` is set to "v" (the default) and the
|
|
labels are set in `x`. By setting `orientation` to "h", the
|
|
roles are interchanged.
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of :class:`plotly.graph_objs.Waterfall`
|
|
alignmentgroup
|
|
Set several traces linked to the same position axis or
|
|
matching axes to the same alignmentgroup. This controls
|
|
whether bars compute their positional range dependently
|
|
or independently.
|
|
base
|
|
Sets where the bar base is drawn (in position axis
|
|
units).
|
|
cliponaxis
|
|
Determines whether the text nodes are clipped about the
|
|
subplot axes. To show the text nodes above axis lines
|
|
and tick labels, make sure to set `xaxis.layer` and
|
|
`yaxis.layer` to *below traces*.
|
|
connector
|
|
:class:`plotly.graph_objects.waterfall.Connector`
|
|
instance or dict with compatible properties
|
|
constraintext
|
|
Constrain the size of text inside or outside a bar to
|
|
be no larger than the bar itself.
|
|
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`.
|
|
decreasing
|
|
:class:`plotly.graph_objects.waterfall.Decreasing`
|
|
instance or dict with compatible properties
|
|
dx
|
|
Sets the x coordinate step. See `x0` for more info.
|
|
dy
|
|
Sets the y coordinate step. See `y0` for more info.
|
|
hoverinfo
|
|
Determines which trace information appear on hover. If
|
|
`none` or `skip` are set, no information is displayed
|
|
upon hovering. But, if `none` is set, click and hover
|
|
events are still fired.
|
|
hoverinfosrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hoverinfo`.
|
|
hoverlabel
|
|
:class:`plotly.graph_objects.waterfall.Hoverlabel`
|
|
instance or dict with compatible properties
|
|
hovertemplate
|
|
Template string used for rendering the information that
|
|
appear on hover box. Note that this will override
|
|
`hoverinfo`. Variables are inserted using %{variable},
|
|
for example "y: %{y}" as well as %{xother}, {%_xother},
|
|
{%_xother_}, {%xother_}. When showing info for several
|
|
points, "xother" will be added to those with different
|
|
x positions from the first point. An underscore before
|
|
or after "(x|y)other" will add a space on that side,
|
|
only when this field is shown. Numbers are formatted
|
|
using d3-format's syntax %{variable:d3-format}, for
|
|
example "Price: %{y:$.2f}".
|
|
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
|
for details on the formatting syntax. Dates are
|
|
formatted using d3-time-format's syntax
|
|
%{variable|d3-time-format}, for example "Day:
|
|
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format for details on the
|
|
date formatting syntax. The variables available in
|
|
`hovertemplate` are the ones emitted as event data
|
|
described at this link
|
|
https://plotly.com/javascript/plotlyjs-events/#event-
|
|
data. Additionally, every attributes that can be
|
|
specified per-point (the ones that are `arrayOk: true`)
|
|
are available. Finally, the template string has access
|
|
to variables `initial`, `delta` and `final`. Anything
|
|
contained in tag `<extra>` is displayed in the
|
|
secondary box, for example
|
|
`<extra>%{fullData.name}</extra>`. To hide the
|
|
secondary box completely, use an empty tag
|
|
`<extra></extra>`.
|
|
hovertemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertemplate`.
|
|
hovertext
|
|
Sets hover text elements associated with each (x,y)
|
|
pair. If a single string, the same string appears over
|
|
all the data points. If an array of string, the items
|
|
are mapped in order to the this trace's (x,y)
|
|
coordinates. To be seen, trace `hoverinfo` must contain
|
|
a "text" flag.
|
|
hovertextsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertext`.
|
|
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`.
|
|
increasing
|
|
:class:`plotly.graph_objects.waterfall.Increasing`
|
|
instance or dict with compatible properties
|
|
insidetextanchor
|
|
Determines if texts are kept at center or start/end
|
|
points in `textposition` "inside" mode.
|
|
insidetextfont
|
|
Sets the font used for `text` lying inside the bar.
|
|
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.
|
|
legendgroup
|
|
Sets the legend group for this trace. Traces and shapes
|
|
part of the same legend group hide/show at the same
|
|
time when toggling legend items.
|
|
legendgrouptitle
|
|
:class:`plotly.graph_objects.waterfall.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.
|
|
measure
|
|
An array containing types of values. By default the
|
|
values are considered as 'relative'. However; it is
|
|
possible to use 'total' to compute the sums. Also
|
|
'absolute' could be applied to reset the computed total
|
|
or to declare an initial value where needed.
|
|
measuresrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`measure`.
|
|
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`.
|
|
name
|
|
Sets the trace name. The trace name appears as the
|
|
legend item and on hover.
|
|
offset
|
|
Shifts the position where the bar is drawn (in position
|
|
axis units). In "group" barmode, traces that set
|
|
"offset" will be excluded and drawn in "overlay" mode
|
|
instead.
|
|
offsetgroup
|
|
Set several traces linked to the same position axis or
|
|
matching axes to the same offsetgroup where bars of the
|
|
same position coordinate will line up.
|
|
offsetsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`offset`.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
orientation
|
|
Sets the orientation of the bars. With "v" ("h"), the
|
|
value of the each bar spans along the vertical
|
|
(horizontal).
|
|
outsidetextfont
|
|
Sets the font used for `text` lying outside the bar.
|
|
selectedpoints
|
|
Array containing integer indices of selected points.
|
|
Has an effect only for traces that support selections.
|
|
Note that an empty array means an empty selection where
|
|
the `unselected` are turned on for all points, whereas,
|
|
any other non-array values means no selection all where
|
|
the `selected` and `unselected` styles have no effect.
|
|
showlegend
|
|
Determines whether or not an item corresponding to this
|
|
trace is shown in the legend.
|
|
stream
|
|
:class:`plotly.graph_objects.waterfall.Stream` instance
|
|
or dict with compatible properties
|
|
text
|
|
Sets text elements associated with each (x,y) pair. If
|
|
a single string, the same string appears over all the
|
|
data points. If an array of string, the items are
|
|
mapped in order to the this trace's (x,y) coordinates.
|
|
If trace `hoverinfo` contains a "text" flag and
|
|
"hovertext" is not set, these elements will be seen in
|
|
the hover labels.
|
|
textangle
|
|
Sets the angle of the tick labels with respect to the
|
|
bar. For example, a `tickangle` of -90 draws the tick
|
|
labels vertically. With "auto" the texts may
|
|
automatically be rotated to fit with the maximum size
|
|
in bars.
|
|
textfont
|
|
Sets the font used for `text`.
|
|
textinfo
|
|
Determines which trace information appear on the graph.
|
|
In the case of having multiple waterfalls, totals are
|
|
computed separately (per trace).
|
|
textposition
|
|
Specifies the location of the `text`. "inside"
|
|
positions `text` inside, next to the bar end (rotated
|
|
and scaled if needed). "outside" positions `text`
|
|
outside, next to the bar end (scaled if needed), unless
|
|
there is another bar stacked on this one, then the text
|
|
gets pushed inside. "auto" tries to position `text`
|
|
inside the bar, but if the bar is too small and no bar
|
|
is stacked on this one the text is moved outside. If
|
|
"none", no text appears.
|
|
textpositionsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`textposition`.
|
|
textsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`text`.
|
|
texttemplate
|
|
Template string used for rendering the information text
|
|
that appear on points. Note that this will override
|
|
`textinfo`. Variables are inserted using %{variable},
|
|
for example "y: %{y}". Numbers are formatted using
|
|
d3-format's syntax %{variable:d3-format}, for example
|
|
"Price: %{y:$.2f}".
|
|
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
|
for details on the formatting syntax. Dates are
|
|
formatted using d3-time-format's syntax
|
|
%{variable|d3-time-format}, for example "Day:
|
|
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format for details on the
|
|
date formatting syntax. Every attributes that can be
|
|
specified per-point (the ones that are `arrayOk: true`)
|
|
are available. Finally, the template string has access
|
|
to variables `initial`, `delta`, `final` and `label`.
|
|
texttemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`texttemplate`.
|
|
totals
|
|
:class:`plotly.graph_objects.waterfall.Totals` 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.
|
|
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).
|
|
width
|
|
Sets the bar width (in position axis units).
|
|
widthsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`width`.
|
|
x
|
|
Sets the x coordinates.
|
|
x0
|
|
Alternate to `x`. Builds a linear space of x
|
|
coordinates. Use with `dx` where `x0` is the starting
|
|
coordinate and `dx` the step.
|
|
xaxis
|
|
Sets a reference between this trace's x coordinates and
|
|
a 2D cartesian x axis. If "x" (the default value), the
|
|
x coordinates refer to `layout.xaxis`. If "x2", the x
|
|
coordinates refer to `layout.xaxis2`, and so on.
|
|
xhoverformat
|
|
Sets the hover text formatting rulefor `x` 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.
|
|
And for dates see: https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format. We add two items to
|
|
d3's date formatter: "%h" for half of the year as a
|
|
decimal number as well as "%{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*By default the values are
|
|
formatted using `xaxis.hoverformat`.
|
|
xperiod
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
period positioning in milliseconds or "M<n>" on the x
|
|
axis. Special values in the form of "M<n>" could be
|
|
used to declare the number of months. In this case `n`
|
|
must be a positive integer.
|
|
xperiod0
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
base for period positioning in milliseconds or date
|
|
string on the x0 axis. When `x0period` is round number
|
|
of weeks, the `x0period0` by default would be on a
|
|
Sunday i.e. 2000-01-02, otherwise it would be at
|
|
2000-01-01.
|
|
xperiodalignment
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the x axis.
|
|
xsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`x`.
|
|
y
|
|
Sets the y coordinates.
|
|
y0
|
|
Alternate to `y`. Builds a linear space of y
|
|
coordinates. Use with `dy` where `y0` is the starting
|
|
coordinate and `dy` the step.
|
|
yaxis
|
|
Sets a reference between this trace's y coordinates and
|
|
a 2D cartesian y axis. If "y" (the default value), the
|
|
y coordinates refer to `layout.yaxis`. If "y2", the y
|
|
coordinates refer to `layout.yaxis2`, and so on.
|
|
yhoverformat
|
|
Sets the hover text formatting rulefor `y` 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.
|
|
And for dates see: https://github.com/d3/d3-time-
|
|
format/tree/v2.2.3#locale_format. We add two items to
|
|
d3's date formatter: "%h" for half of the year as a
|
|
decimal number as well as "%{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*By default the values are
|
|
formatted using `yaxis.hoverformat`.
|
|
yperiod
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
period positioning in milliseconds or "M<n>" on the y
|
|
axis. Special values in the form of "M<n>" could be
|
|
used to declare the number of months. In this case `n`
|
|
must be a positive integer.
|
|
yperiod0
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
base for period positioning in milliseconds or date
|
|
string on the y0 axis. When `y0period` is round number
|
|
of weeks, the `y0period0` by default would be on a
|
|
Sunday i.e. 2000-01-02, otherwise it would be at
|
|
2000-01-01.
|
|
yperiodalignment
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the y axis.
|
|
ysrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`y`.
|
|
zorder
|
|
Sets the layer on which this trace is displayed,
|
|
relative to other SVG traces on the same subplot. SVG
|
|
traces with higher `zorder` appear in front of those
|
|
with lower `zorder`.
|
|
|
|
Returns
|
|
-------
|
|
Waterfall
|
|
"""
|
|
super().__init__("waterfall")
|
|
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.Waterfall
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.Waterfall`""")
|
|
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|
self._validate = kwargs.pop("_validate", True)
|
|
|
|
self._set_property("alignmentgroup", arg, alignmentgroup)
|
|
self._set_property("base", arg, base)
|
|
self._set_property("cliponaxis", arg, cliponaxis)
|
|
self._set_property("connector", arg, connector)
|
|
self._set_property("constraintext", arg, constraintext)
|
|
self._set_property("customdata", arg, customdata)
|
|
self._set_property("customdatasrc", arg, customdatasrc)
|
|
self._set_property("decreasing", arg, decreasing)
|
|
self._set_property("dx", arg, dx)
|
|
self._set_property("dy", arg, dy)
|
|
self._set_property("hoverinfo", arg, hoverinfo)
|
|
self._set_property("hoverinfosrc", arg, hoverinfosrc)
|
|
self._set_property("hoverlabel", arg, hoverlabel)
|
|
self._set_property("hovertemplate", arg, hovertemplate)
|
|
self._set_property("hovertemplatesrc", arg, hovertemplatesrc)
|
|
self._set_property("hovertext", arg, hovertext)
|
|
self._set_property("hovertextsrc", arg, hovertextsrc)
|
|
self._set_property("ids", arg, ids)
|
|
self._set_property("idssrc", arg, idssrc)
|
|
self._set_property("increasing", arg, increasing)
|
|
self._set_property("insidetextanchor", arg, insidetextanchor)
|
|
self._set_property("insidetextfont", arg, insidetextfont)
|
|
self._set_property("legend", arg, legend)
|
|
self._set_property("legendgroup", arg, legendgroup)
|
|
self._set_property("legendgrouptitle", arg, legendgrouptitle)
|
|
self._set_property("legendrank", arg, legendrank)
|
|
self._set_property("legendwidth", arg, legendwidth)
|
|
self._set_property("measure", arg, measure)
|
|
self._set_property("measuresrc", arg, measuresrc)
|
|
self._set_property("meta", arg, meta)
|
|
self._set_property("metasrc", arg, metasrc)
|
|
self._set_property("name", arg, name)
|
|
self._set_property("offset", arg, offset)
|
|
self._set_property("offsetgroup", arg, offsetgroup)
|
|
self._set_property("offsetsrc", arg, offsetsrc)
|
|
self._set_property("opacity", arg, opacity)
|
|
self._set_property("orientation", arg, orientation)
|
|
self._set_property("outsidetextfont", arg, outsidetextfont)
|
|
self._set_property("selectedpoints", arg, selectedpoints)
|
|
self._set_property("showlegend", arg, showlegend)
|
|
self._set_property("stream", arg, stream)
|
|
self._set_property("text", arg, text)
|
|
self._set_property("textangle", arg, textangle)
|
|
self._set_property("textfont", arg, textfont)
|
|
self._set_property("textinfo", arg, textinfo)
|
|
self._set_property("textposition", arg, textposition)
|
|
self._set_property("textpositionsrc", arg, textpositionsrc)
|
|
self._set_property("textsrc", arg, textsrc)
|
|
self._set_property("texttemplate", arg, texttemplate)
|
|
self._set_property("texttemplatesrc", arg, texttemplatesrc)
|
|
self._set_property("totals", arg, totals)
|
|
self._set_property("uid", arg, uid)
|
|
self._set_property("uirevision", arg, uirevision)
|
|
self._set_property("visible", arg, visible)
|
|
self._set_property("width", arg, width)
|
|
self._set_property("widthsrc", arg, widthsrc)
|
|
self._set_property("x", arg, x)
|
|
self._set_property("x0", arg, x0)
|
|
self._set_property("xaxis", arg, xaxis)
|
|
self._set_property("xhoverformat", arg, xhoverformat)
|
|
self._set_property("xperiod", arg, xperiod)
|
|
self._set_property("xperiod0", arg, xperiod0)
|
|
self._set_property("xperiodalignment", arg, xperiodalignment)
|
|
self._set_property("xsrc", arg, xsrc)
|
|
self._set_property("y", arg, y)
|
|
self._set_property("y0", arg, y0)
|
|
self._set_property("yaxis", arg, yaxis)
|
|
self._set_property("yhoverformat", arg, yhoverformat)
|
|
self._set_property("yperiod", arg, yperiod)
|
|
self._set_property("yperiod0", arg, yperiod0)
|
|
self._set_property("yperiodalignment", arg, yperiodalignment)
|
|
self._set_property("ysrc", arg, ysrc)
|
|
self._set_property("zorder", arg, zorder)
|
|
|
|
self._props["type"] = "waterfall"
|
|
arg.pop("type", None)
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
self._skip_invalid = False
|