2043 lines
67 KiB
Python
2043 lines
67 KiB
Python
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
|
import copy as _copy
|
|
|
|
|
|
class Barpolar(_BaseTraceType):
|
|
|
|
# class properties
|
|
# --------------------
|
|
_parent_path_str = ""
|
|
_path_str = "barpolar"
|
|
_valid_props = {
|
|
"base",
|
|
"basesrc",
|
|
"customdata",
|
|
"customdatasrc",
|
|
"dr",
|
|
"dtheta",
|
|
"hoverinfo",
|
|
"hoverinfosrc",
|
|
"hoverlabel",
|
|
"hovertemplate",
|
|
"hovertemplatesrc",
|
|
"hovertext",
|
|
"hovertextsrc",
|
|
"ids",
|
|
"idssrc",
|
|
"legend",
|
|
"legendgroup",
|
|
"legendgrouptitle",
|
|
"legendrank",
|
|
"legendwidth",
|
|
"marker",
|
|
"meta",
|
|
"metasrc",
|
|
"name",
|
|
"offset",
|
|
"offsetsrc",
|
|
"opacity",
|
|
"r",
|
|
"r0",
|
|
"rsrc",
|
|
"selected",
|
|
"selectedpoints",
|
|
"showlegend",
|
|
"stream",
|
|
"subplot",
|
|
"text",
|
|
"textsrc",
|
|
"theta",
|
|
"theta0",
|
|
"thetasrc",
|
|
"thetaunit",
|
|
"type",
|
|
"uid",
|
|
"uirevision",
|
|
"unselected",
|
|
"visible",
|
|
"width",
|
|
"widthsrc",
|
|
}
|
|
|
|
# base
|
|
# ----
|
|
@property
|
|
def base(self):
|
|
"""
|
|
Sets where the bar base is drawn (in radial axis units). In
|
|
"stack" barmode, traces that set "base" will be excluded and
|
|
drawn in "overlay" mode instead.
|
|
|
|
The 'base' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any|numpy.ndarray
|
|
"""
|
|
return self["base"]
|
|
|
|
@base.setter
|
|
def base(self, val):
|
|
self["base"] = val
|
|
|
|
# basesrc
|
|
# -------
|
|
@property
|
|
def basesrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `base`.
|
|
|
|
The 'basesrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["basesrc"]
|
|
|
|
@basesrc.setter
|
|
def basesrc(self, val):
|
|
self["basesrc"] = val
|
|
|
|
# customdata
|
|
# ----------
|
|
@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
|
|
|
|
# customdatasrc
|
|
# -------------
|
|
@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
|
|
|
|
# dr
|
|
# --
|
|
@property
|
|
def dr(self):
|
|
"""
|
|
Sets the r coordinate step.
|
|
|
|
The 'dr' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["dr"]
|
|
|
|
@dr.setter
|
|
def dr(self, val):
|
|
self["dr"] = val
|
|
|
|
# dtheta
|
|
# ------
|
|
@property
|
|
def dtheta(self):
|
|
"""
|
|
Sets the theta coordinate step. By default, the `dtheta` step
|
|
equals the subplot's period divided by the length of the `r`
|
|
coordinates.
|
|
|
|
The 'dtheta' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["dtheta"]
|
|
|
|
@dtheta.setter
|
|
def dtheta(self, val):
|
|
self["dtheta"] = val
|
|
|
|
# hoverinfo
|
|
# ---------
|
|
@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 ['r', 'theta', 'text', 'name'] joined with '+' characters
|
|
(e.g. 'r+theta')
|
|
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
|
|
|
|
# hoverinfosrc
|
|
# ------------
|
|
@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
|
|
|
|
# hoverlabel
|
|
# ----------
|
|
@property
|
|
def hoverlabel(self):
|
|
"""
|
|
The 'hoverlabel' property is an instance of Hoverlabel
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.barpolar.Hoverlabel`
|
|
- A dict of string/value properties that will be passed
|
|
to the Hoverlabel constructor
|
|
|
|
Supported dict properties:
|
|
|
|
align
|
|
Sets the horizontal alignment of the text
|
|
content within hover label box. Has an effect
|
|
only if the hover label text spans more two or
|
|
more lines
|
|
alignsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `align`.
|
|
bgcolor
|
|
Sets the background color of the hover labels
|
|
for this trace
|
|
bgcolorsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `bgcolor`.
|
|
bordercolor
|
|
Sets the border color of the hover labels for
|
|
this trace.
|
|
bordercolorsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `bordercolor`.
|
|
font
|
|
Sets the font used in hover labels.
|
|
namelength
|
|
Sets the default length (in number of
|
|
characters) of the trace name in the hover
|
|
labels for all traces. -1 shows the whole name
|
|
regardless of length. 0-3 shows the first 0-3
|
|
characters, and an integer >3 will show the
|
|
whole name if it is less than that many
|
|
characters, but if it is longer, will truncate
|
|
to `namelength - 3` characters and add an
|
|
ellipsis.
|
|
namelengthsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `namelength`.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.barpolar.Hoverlabel
|
|
"""
|
|
return self["hoverlabel"]
|
|
|
|
@hoverlabel.setter
|
|
def hoverlabel(self, val):
|
|
self["hoverlabel"] = val
|
|
|
|
# hovertemplate
|
|
# -------------
|
|
@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. 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
|
|
|
|
# hovertemplatesrc
|
|
# ----------------
|
|
@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
|
|
|
|
# hovertext
|
|
# ---------
|
|
@property
|
|
def hovertext(self):
|
|
"""
|
|
Same as `text`.
|
|
|
|
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
|
|
|
|
# hovertextsrc
|
|
# ------------
|
|
@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
|
|
|
|
# ids
|
|
# ---
|
|
@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
|
|
|
|
# idssrc
|
|
# ------
|
|
@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
|
|
|
|
# legend
|
|
# ------
|
|
@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
|
|
|
|
# legendgroup
|
|
# -----------
|
|
@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
|
|
|
|
# legendgrouptitle
|
|
# ----------------
|
|
@property
|
|
def legendgrouptitle(self):
|
|
"""
|
|
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.barpolar.Legendgrouptitle`
|
|
- A dict of string/value properties that will be passed
|
|
to the Legendgrouptitle constructor
|
|
|
|
Supported dict properties:
|
|
|
|
font
|
|
Sets this legend group's title font.
|
|
text
|
|
Sets the title of the legend group.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.barpolar.Legendgrouptitle
|
|
"""
|
|
return self["legendgrouptitle"]
|
|
|
|
@legendgrouptitle.setter
|
|
def legendgrouptitle(self, val):
|
|
self["legendgrouptitle"] = val
|
|
|
|
# legendrank
|
|
# ----------
|
|
@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
|
|
|
|
# legendwidth
|
|
# -----------
|
|
@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
|
|
|
|
# marker
|
|
# ------
|
|
@property
|
|
def marker(self):
|
|
"""
|
|
The 'marker' property is an instance of Marker
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.barpolar.Marker`
|
|
- A dict of string/value properties that will be passed
|
|
to the Marker constructor
|
|
|
|
Supported dict properties:
|
|
|
|
autocolorscale
|
|
Determines whether the colorscale is a default
|
|
palette (`autocolorscale: true`) or the palette
|
|
determined by `marker.colorscale`. Has an
|
|
effect only if in `marker.color` is set to a
|
|
numerical array. In case `colorscale` is
|
|
unspecified or `autocolorscale` is true, the
|
|
default palette will be chosen according to
|
|
whether numbers in the `color` array are all
|
|
positive, all negative or mixed.
|
|
cauto
|
|
Determines whether or not the color domain is
|
|
computed with respect to the input data (here
|
|
in `marker.color`) or the bounds set in
|
|
`marker.cmin` and `marker.cmax` Has an effect
|
|
only if in `marker.color` is set to a numerical
|
|
array. Defaults to `false` when `marker.cmin`
|
|
and `marker.cmax` are set by the user.
|
|
cmax
|
|
Sets the upper bound of the color domain. Has
|
|
an effect only if in `marker.color` is set to a
|
|
numerical array. Value should have the same
|
|
units as in `marker.color` and if set,
|
|
`marker.cmin` must be set as well.
|
|
cmid
|
|
Sets the mid-point of the color domain by
|
|
scaling `marker.cmin` and/or `marker.cmax` to
|
|
be equidistant to this point. Has an effect
|
|
only if in `marker.color` is set to a numerical
|
|
array. Value should have the same units as in
|
|
`marker.color`. Has no effect when
|
|
`marker.cauto` is `false`.
|
|
cmin
|
|
Sets the lower bound of the color domain. Has
|
|
an effect only if in `marker.color` is set to a
|
|
numerical array. Value should have the same
|
|
units as in `marker.color` and if set,
|
|
`marker.cmax` must be set as well.
|
|
color
|
|
Sets the marker color. It accepts either a
|
|
specific color or an array of numbers that are
|
|
mapped to the colorscale relative to the max
|
|
and min values of the array or relative to
|
|
`marker.cmin` and `marker.cmax` if set.
|
|
coloraxis
|
|
Sets a reference to a shared color axis.
|
|
References to these shared color axes are
|
|
"coloraxis", "coloraxis2", "coloraxis3", etc.
|
|
Settings for these shared color axes are set in
|
|
the layout, under `layout.coloraxis`,
|
|
`layout.coloraxis2`, etc. Note that multiple
|
|
color scales can be linked to the same color
|
|
axis.
|
|
colorbar
|
|
:class:`plotly.graph_objects.barpolar.marker.Co
|
|
lorBar` instance or dict with compatible
|
|
properties
|
|
colorscale
|
|
Sets the colorscale. Has an effect only if in
|
|
`marker.color` is set to a numerical array. The
|
|
colorscale must be an array containing arrays
|
|
mapping a normalized value to an rgb, rgba,
|
|
hex, hsl, hsv, or named color string. At
|
|
minimum, a mapping for the lowest (0) and
|
|
highest (1) values are required. For example,
|
|
`[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
|
To control the bounds of the colorscale in
|
|
color space, use `marker.cmin` and
|
|
`marker.cmax`. Alternatively, `colorscale` may
|
|
be a palette name string of the following list:
|
|
Blackbody,Bluered,Blues,Cividis,Earth,Electric,
|
|
Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
|
|
Bu,Reds,Viridis,YlGnBu,YlOrRd.
|
|
colorsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `color`.
|
|
line
|
|
:class:`plotly.graph_objects.barpolar.marker.Li
|
|
ne` instance or dict with compatible properties
|
|
opacity
|
|
Sets the opacity of the bars.
|
|
opacitysrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `opacity`.
|
|
pattern
|
|
Sets the pattern within the marker.
|
|
reversescale
|
|
Reverses the color mapping if true. Has an
|
|
effect only if in `marker.color` is set to a
|
|
numerical array. If true, `marker.cmin` will
|
|
correspond to the last color in the array and
|
|
`marker.cmax` will correspond to the first
|
|
color.
|
|
showscale
|
|
Determines whether or not a colorbar is
|
|
displayed for this trace. Has an effect only if
|
|
in `marker.color` is set to a numerical array.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.barpolar.Marker
|
|
"""
|
|
return self["marker"]
|
|
|
|
@marker.setter
|
|
def marker(self, val):
|
|
self["marker"] = val
|
|
|
|
# meta
|
|
# ----
|
|
@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
|
|
|
|
# metasrc
|
|
# -------
|
|
@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
|
|
|
|
# name
|
|
# ----
|
|
@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
|
|
|
|
# offset
|
|
# ------
|
|
@property
|
|
def offset(self):
|
|
"""
|
|
Shifts the angular position where the bar is drawn (in
|
|
"thetatunit" units).
|
|
|
|
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
|
|
|
|
# offsetsrc
|
|
# ---------
|
|
@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
|
|
|
|
# opacity
|
|
# -------
|
|
@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
|
|
|
|
# r
|
|
# -
|
|
@property
|
|
def r(self):
|
|
"""
|
|
Sets the radial coordinates
|
|
|
|
The 'r' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["r"]
|
|
|
|
@r.setter
|
|
def r(self, val):
|
|
self["r"] = val
|
|
|
|
# r0
|
|
# --
|
|
@property
|
|
def r0(self):
|
|
"""
|
|
Alternate to `r`. Builds a linear space of r coordinates. Use
|
|
with `dr` where `r0` is the starting coordinate and `dr` the
|
|
step.
|
|
|
|
The 'r0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["r0"]
|
|
|
|
@r0.setter
|
|
def r0(self, val):
|
|
self["r0"] = val
|
|
|
|
# rsrc
|
|
# ----
|
|
@property
|
|
def rsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `r`.
|
|
|
|
The 'rsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["rsrc"]
|
|
|
|
@rsrc.setter
|
|
def rsrc(self, val):
|
|
self["rsrc"] = val
|
|
|
|
# selected
|
|
# --------
|
|
@property
|
|
def selected(self):
|
|
"""
|
|
The 'selected' property is an instance of Selected
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.barpolar.Selected`
|
|
- A dict of string/value properties that will be passed
|
|
to the Selected constructor
|
|
|
|
Supported dict properties:
|
|
|
|
marker
|
|
:class:`plotly.graph_objects.barpolar.selected.
|
|
Marker` instance or dict with compatible
|
|
properties
|
|
textfont
|
|
:class:`plotly.graph_objects.barpolar.selected.
|
|
Textfont` instance or dict with compatible
|
|
properties
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.barpolar.Selected
|
|
"""
|
|
return self["selected"]
|
|
|
|
@selected.setter
|
|
def selected(self, val):
|
|
self["selected"] = val
|
|
|
|
# selectedpoints
|
|
# --------------
|
|
@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
|
|
|
|
# showlegend
|
|
# ----------
|
|
@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
|
|
|
|
# stream
|
|
# ------
|
|
@property
|
|
def stream(self):
|
|
"""
|
|
The 'stream' property is an instance of Stream
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.barpolar.Stream`
|
|
- A dict of string/value properties that will be passed
|
|
to the Stream constructor
|
|
|
|
Supported dict properties:
|
|
|
|
maxpoints
|
|
Sets the maximum number of points to keep on
|
|
the plots from an incoming stream. If
|
|
`maxpoints` is set to 50, only the newest 50
|
|
points will be displayed on the plot.
|
|
token
|
|
The stream id number links a data trace on a
|
|
plot with a stream. See https://chart-
|
|
studio.plotly.com/settings for more details.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.barpolar.Stream
|
|
"""
|
|
return self["stream"]
|
|
|
|
@stream.setter
|
|
def stream(self, val):
|
|
self["stream"] = val
|
|
|
|
# subplot
|
|
# -------
|
|
@property
|
|
def subplot(self):
|
|
"""
|
|
Sets a reference between this trace's data coordinates and a
|
|
polar subplot. If "polar" (the default value), the data refer
|
|
to `layout.polar`. If "polar2", the data refer to
|
|
`layout.polar2`, and so on.
|
|
|
|
The 'subplot' property is an identifier of a particular
|
|
subplot, of type 'polar', that may be specified as the string 'polar'
|
|
optionally followed by an integer >= 1
|
|
(e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.)
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["subplot"]
|
|
|
|
@subplot.setter
|
|
def subplot(self, val):
|
|
self["subplot"] = val
|
|
|
|
# text
|
|
# ----
|
|
@property
|
|
def text(self):
|
|
"""
|
|
Sets hover text elements associated with each bar. If a single
|
|
string, the same string appears over all bars. If an array of
|
|
string, the items are mapped in order to the this trace's
|
|
coordinates.
|
|
|
|
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
|
|
|
|
# textsrc
|
|
# -------
|
|
@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
|
|
|
|
# theta
|
|
# -----
|
|
@property
|
|
def theta(self):
|
|
"""
|
|
Sets the angular coordinates
|
|
|
|
The 'theta' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["theta"]
|
|
|
|
@theta.setter
|
|
def theta(self, val):
|
|
self["theta"] = val
|
|
|
|
# theta0
|
|
# ------
|
|
@property
|
|
def theta0(self):
|
|
"""
|
|
Alternate to `theta`. Builds a linear space of theta
|
|
coordinates. Use with `dtheta` where `theta0` is the starting
|
|
coordinate and `dtheta` the step.
|
|
|
|
The 'theta0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["theta0"]
|
|
|
|
@theta0.setter
|
|
def theta0(self, val):
|
|
self["theta0"] = val
|
|
|
|
# thetasrc
|
|
# --------
|
|
@property
|
|
def thetasrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `theta`.
|
|
|
|
The 'thetasrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["thetasrc"]
|
|
|
|
@thetasrc.setter
|
|
def thetasrc(self, val):
|
|
self["thetasrc"] = val
|
|
|
|
# thetaunit
|
|
# ---------
|
|
@property
|
|
def thetaunit(self):
|
|
"""
|
|
Sets the unit of input "theta" values. Has an effect only when
|
|
on "linear" angular axes.
|
|
|
|
The 'thetaunit' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['radians', 'degrees', 'gradians']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["thetaunit"]
|
|
|
|
@thetaunit.setter
|
|
def thetaunit(self, val):
|
|
self["thetaunit"] = val
|
|
|
|
# uid
|
|
# ---
|
|
@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
|
|
|
|
# uirevision
|
|
# ----------
|
|
@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
|
|
|
|
# unselected
|
|
# ----------
|
|
@property
|
|
def unselected(self):
|
|
"""
|
|
The 'unselected' property is an instance of Unselected
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.barpolar.Unselected`
|
|
- A dict of string/value properties that will be passed
|
|
to the Unselected constructor
|
|
|
|
Supported dict properties:
|
|
|
|
marker
|
|
:class:`plotly.graph_objects.barpolar.unselecte
|
|
d.Marker` instance or dict with compatible
|
|
properties
|
|
textfont
|
|
:class:`plotly.graph_objects.barpolar.unselecte
|
|
d.Textfont` instance or dict with compatible
|
|
properties
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.barpolar.Unselected
|
|
"""
|
|
return self["unselected"]
|
|
|
|
@unselected.setter
|
|
def unselected(self, val):
|
|
self["unselected"] = val
|
|
|
|
# visible
|
|
# -------
|
|
@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
|
|
|
|
# width
|
|
# -----
|
|
@property
|
|
def width(self):
|
|
"""
|
|
Sets the bar angular width (in "thetaunit" 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
|
|
|
|
# widthsrc
|
|
# --------
|
|
@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
|
|
|
|
# type
|
|
# ----
|
|
@property
|
|
def type(self):
|
|
return self._props["type"]
|
|
|
|
# Self properties description
|
|
# ---------------------------
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
base
|
|
Sets where the bar base is drawn (in radial axis
|
|
units). In "stack" barmode, traces that set "base" will
|
|
be excluded and drawn in "overlay" mode instead.
|
|
basesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`base`.
|
|
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`.
|
|
dr
|
|
Sets the r coordinate step.
|
|
dtheta
|
|
Sets the theta coordinate step. By default, the
|
|
`dtheta` step equals the subplot's period divided by
|
|
the length of the `r` coordinates.
|
|
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.barpolar.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. 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
|
|
Same as `text`.
|
|
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`.
|
|
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.barpolar.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.
|
|
marker
|
|
:class:`plotly.graph_objects.barpolar.Marker` instance
|
|
or dict with compatible properties
|
|
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 angular position where the bar is drawn (in
|
|
"thetatunit" units).
|
|
offsetsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`offset`.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
r
|
|
Sets the radial coordinates
|
|
r0
|
|
Alternate to `r`. Builds a linear space of r
|
|
coordinates. Use with `dr` where `r0` is the starting
|
|
coordinate and `dr` the step.
|
|
rsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`r`.
|
|
selected
|
|
:class:`plotly.graph_objects.barpolar.Selected`
|
|
instance or dict with compatible properties
|
|
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.barpolar.Stream` instance
|
|
or dict with compatible properties
|
|
subplot
|
|
Sets a reference between this trace's data coordinates
|
|
and a polar subplot. If "polar" (the default value),
|
|
the data refer to `layout.polar`. If "polar2", the data
|
|
refer to `layout.polar2`, and so on.
|
|
text
|
|
Sets hover text elements associated with each bar. If a
|
|
single string, the same string appears over all bars.
|
|
If an array of string, the items are mapped in order to
|
|
the this trace's coordinates.
|
|
textsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`text`.
|
|
theta
|
|
Sets the angular coordinates
|
|
theta0
|
|
Alternate to `theta`. Builds a linear space of theta
|
|
coordinates. Use with `dtheta` where `theta0` is the
|
|
starting coordinate and `dtheta` the step.
|
|
thetasrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`theta`.
|
|
thetaunit
|
|
Sets the unit of input "theta" values. Has an effect
|
|
only when on "linear" angular axes.
|
|
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.
|
|
unselected
|
|
:class:`plotly.graph_objects.barpolar.Unselected`
|
|
instance or dict with compatible properties
|
|
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 angular width (in "thetaunit" units).
|
|
widthsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`width`.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
arg=None,
|
|
base=None,
|
|
basesrc=None,
|
|
customdata=None,
|
|
customdatasrc=None,
|
|
dr=None,
|
|
dtheta=None,
|
|
hoverinfo=None,
|
|
hoverinfosrc=None,
|
|
hoverlabel=None,
|
|
hovertemplate=None,
|
|
hovertemplatesrc=None,
|
|
hovertext=None,
|
|
hovertextsrc=None,
|
|
ids=None,
|
|
idssrc=None,
|
|
legend=None,
|
|
legendgroup=None,
|
|
legendgrouptitle=None,
|
|
legendrank=None,
|
|
legendwidth=None,
|
|
marker=None,
|
|
meta=None,
|
|
metasrc=None,
|
|
name=None,
|
|
offset=None,
|
|
offsetsrc=None,
|
|
opacity=None,
|
|
r=None,
|
|
r0=None,
|
|
rsrc=None,
|
|
selected=None,
|
|
selectedpoints=None,
|
|
showlegend=None,
|
|
stream=None,
|
|
subplot=None,
|
|
text=None,
|
|
textsrc=None,
|
|
theta=None,
|
|
theta0=None,
|
|
thetasrc=None,
|
|
thetaunit=None,
|
|
uid=None,
|
|
uirevision=None,
|
|
unselected=None,
|
|
visible=None,
|
|
width=None,
|
|
widthsrc=None,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
Construct a new Barpolar object
|
|
|
|
The data visualized by the radial span of the bars is set in
|
|
`r`
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of :class:`plotly.graph_objs.Barpolar`
|
|
base
|
|
Sets where the bar base is drawn (in radial axis
|
|
units). In "stack" barmode, traces that set "base" will
|
|
be excluded and drawn in "overlay" mode instead.
|
|
basesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`base`.
|
|
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`.
|
|
dr
|
|
Sets the r coordinate step.
|
|
dtheta
|
|
Sets the theta coordinate step. By default, the
|
|
`dtheta` step equals the subplot's period divided by
|
|
the length of the `r` coordinates.
|
|
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.barpolar.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. 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
|
|
Same as `text`.
|
|
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`.
|
|
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.barpolar.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.
|
|
marker
|
|
:class:`plotly.graph_objects.barpolar.Marker` instance
|
|
or dict with compatible properties
|
|
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 angular position where the bar is drawn (in
|
|
"thetatunit" units).
|
|
offsetsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`offset`.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
r
|
|
Sets the radial coordinates
|
|
r0
|
|
Alternate to `r`. Builds a linear space of r
|
|
coordinates. Use with `dr` where `r0` is the starting
|
|
coordinate and `dr` the step.
|
|
rsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`r`.
|
|
selected
|
|
:class:`plotly.graph_objects.barpolar.Selected`
|
|
instance or dict with compatible properties
|
|
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.barpolar.Stream` instance
|
|
or dict with compatible properties
|
|
subplot
|
|
Sets a reference between this trace's data coordinates
|
|
and a polar subplot. If "polar" (the default value),
|
|
the data refer to `layout.polar`. If "polar2", the data
|
|
refer to `layout.polar2`, and so on.
|
|
text
|
|
Sets hover text elements associated with each bar. If a
|
|
single string, the same string appears over all bars.
|
|
If an array of string, the items are mapped in order to
|
|
the this trace's coordinates.
|
|
textsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`text`.
|
|
theta
|
|
Sets the angular coordinates
|
|
theta0
|
|
Alternate to `theta`. Builds a linear space of theta
|
|
coordinates. Use with `dtheta` where `theta0` is the
|
|
starting coordinate and `dtheta` the step.
|
|
thetasrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`theta`.
|
|
thetaunit
|
|
Sets the unit of input "theta" values. Has an effect
|
|
only when on "linear" angular axes.
|
|
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.
|
|
unselected
|
|
:class:`plotly.graph_objects.barpolar.Unselected`
|
|
instance or dict with compatible properties
|
|
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 angular width (in "thetaunit" units).
|
|
widthsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`width`.
|
|
|
|
Returns
|
|
-------
|
|
Barpolar
|
|
"""
|
|
super(Barpolar, self).__init__("barpolar")
|
|
|
|
if "_parent" in kwargs:
|
|
self._parent = kwargs["_parent"]
|
|
return
|
|
|
|
# Validate arg
|
|
# ------------
|
|
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.Barpolar
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.Barpolar`"""
|
|
)
|
|
|
|
# Handle skip_invalid
|
|
# -------------------
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|
self._validate = kwargs.pop("_validate", True)
|
|
|
|
# Populate data dict with properties
|
|
# ----------------------------------
|
|
_v = arg.pop("base", None)
|
|
_v = base if base is not None else _v
|
|
if _v is not None:
|
|
self["base"] = _v
|
|
_v = arg.pop("basesrc", None)
|
|
_v = basesrc if basesrc is not None else _v
|
|
if _v is not None:
|
|
self["basesrc"] = _v
|
|
_v = arg.pop("customdata", None)
|
|
_v = customdata if customdata is not None else _v
|
|
if _v is not None:
|
|
self["customdata"] = _v
|
|
_v = arg.pop("customdatasrc", None)
|
|
_v = customdatasrc if customdatasrc is not None else _v
|
|
if _v is not None:
|
|
self["customdatasrc"] = _v
|
|
_v = arg.pop("dr", None)
|
|
_v = dr if dr is not None else _v
|
|
if _v is not None:
|
|
self["dr"] = _v
|
|
_v = arg.pop("dtheta", None)
|
|
_v = dtheta if dtheta is not None else _v
|
|
if _v is not None:
|
|
self["dtheta"] = _v
|
|
_v = arg.pop("hoverinfo", None)
|
|
_v = hoverinfo if hoverinfo is not None else _v
|
|
if _v is not None:
|
|
self["hoverinfo"] = _v
|
|
_v = arg.pop("hoverinfosrc", None)
|
|
_v = hoverinfosrc if hoverinfosrc is not None else _v
|
|
if _v is not None:
|
|
self["hoverinfosrc"] = _v
|
|
_v = arg.pop("hoverlabel", None)
|
|
_v = hoverlabel if hoverlabel is not None else _v
|
|
if _v is not None:
|
|
self["hoverlabel"] = _v
|
|
_v = arg.pop("hovertemplate", None)
|
|
_v = hovertemplate if hovertemplate is not None else _v
|
|
if _v is not None:
|
|
self["hovertemplate"] = _v
|
|
_v = arg.pop("hovertemplatesrc", None)
|
|
_v = hovertemplatesrc if hovertemplatesrc is not None else _v
|
|
if _v is not None:
|
|
self["hovertemplatesrc"] = _v
|
|
_v = arg.pop("hovertext", None)
|
|
_v = hovertext if hovertext is not None else _v
|
|
if _v is not None:
|
|
self["hovertext"] = _v
|
|
_v = arg.pop("hovertextsrc", None)
|
|
_v = hovertextsrc if hovertextsrc is not None else _v
|
|
if _v is not None:
|
|
self["hovertextsrc"] = _v
|
|
_v = arg.pop("ids", None)
|
|
_v = ids if ids is not None else _v
|
|
if _v is not None:
|
|
self["ids"] = _v
|
|
_v = arg.pop("idssrc", None)
|
|
_v = idssrc if idssrc is not None else _v
|
|
if _v is not None:
|
|
self["idssrc"] = _v
|
|
_v = arg.pop("legend", None)
|
|
_v = legend if legend is not None else _v
|
|
if _v is not None:
|
|
self["legend"] = _v
|
|
_v = arg.pop("legendgroup", None)
|
|
_v = legendgroup if legendgroup is not None else _v
|
|
if _v is not None:
|
|
self["legendgroup"] = _v
|
|
_v = arg.pop("legendgrouptitle", None)
|
|
_v = legendgrouptitle if legendgrouptitle is not None else _v
|
|
if _v is not None:
|
|
self["legendgrouptitle"] = _v
|
|
_v = arg.pop("legendrank", None)
|
|
_v = legendrank if legendrank is not None else _v
|
|
if _v is not None:
|
|
self["legendrank"] = _v
|
|
_v = arg.pop("legendwidth", None)
|
|
_v = legendwidth if legendwidth is not None else _v
|
|
if _v is not None:
|
|
self["legendwidth"] = _v
|
|
_v = arg.pop("marker", None)
|
|
_v = marker if marker is not None else _v
|
|
if _v is not None:
|
|
self["marker"] = _v
|
|
_v = arg.pop("meta", None)
|
|
_v = meta if meta is not None else _v
|
|
if _v is not None:
|
|
self["meta"] = _v
|
|
_v = arg.pop("metasrc", None)
|
|
_v = metasrc if metasrc is not None else _v
|
|
if _v is not None:
|
|
self["metasrc"] = _v
|
|
_v = arg.pop("name", None)
|
|
_v = name if name is not None else _v
|
|
if _v is not None:
|
|
self["name"] = _v
|
|
_v = arg.pop("offset", None)
|
|
_v = offset if offset is not None else _v
|
|
if _v is not None:
|
|
self["offset"] = _v
|
|
_v = arg.pop("offsetsrc", None)
|
|
_v = offsetsrc if offsetsrc is not None else _v
|
|
if _v is not None:
|
|
self["offsetsrc"] = _v
|
|
_v = arg.pop("opacity", None)
|
|
_v = opacity if opacity is not None else _v
|
|
if _v is not None:
|
|
self["opacity"] = _v
|
|
_v = arg.pop("r", None)
|
|
_v = r if r is not None else _v
|
|
if _v is not None:
|
|
self["r"] = _v
|
|
_v = arg.pop("r0", None)
|
|
_v = r0 if r0 is not None else _v
|
|
if _v is not None:
|
|
self["r0"] = _v
|
|
_v = arg.pop("rsrc", None)
|
|
_v = rsrc if rsrc is not None else _v
|
|
if _v is not None:
|
|
self["rsrc"] = _v
|
|
_v = arg.pop("selected", None)
|
|
_v = selected if selected is not None else _v
|
|
if _v is not None:
|
|
self["selected"] = _v
|
|
_v = arg.pop("selectedpoints", None)
|
|
_v = selectedpoints if selectedpoints is not None else _v
|
|
if _v is not None:
|
|
self["selectedpoints"] = _v
|
|
_v = arg.pop("showlegend", None)
|
|
_v = showlegend if showlegend is not None else _v
|
|
if _v is not None:
|
|
self["showlegend"] = _v
|
|
_v = arg.pop("stream", None)
|
|
_v = stream if stream is not None else _v
|
|
if _v is not None:
|
|
self["stream"] = _v
|
|
_v = arg.pop("subplot", None)
|
|
_v = subplot if subplot is not None else _v
|
|
if _v is not None:
|
|
self["subplot"] = _v
|
|
_v = arg.pop("text", None)
|
|
_v = text if text is not None else _v
|
|
if _v is not None:
|
|
self["text"] = _v
|
|
_v = arg.pop("textsrc", None)
|
|
_v = textsrc if textsrc is not None else _v
|
|
if _v is not None:
|
|
self["textsrc"] = _v
|
|
_v = arg.pop("theta", None)
|
|
_v = theta if theta is not None else _v
|
|
if _v is not None:
|
|
self["theta"] = _v
|
|
_v = arg.pop("theta0", None)
|
|
_v = theta0 if theta0 is not None else _v
|
|
if _v is not None:
|
|
self["theta0"] = _v
|
|
_v = arg.pop("thetasrc", None)
|
|
_v = thetasrc if thetasrc is not None else _v
|
|
if _v is not None:
|
|
self["thetasrc"] = _v
|
|
_v = arg.pop("thetaunit", None)
|
|
_v = thetaunit if thetaunit is not None else _v
|
|
if _v is not None:
|
|
self["thetaunit"] = _v
|
|
_v = arg.pop("uid", None)
|
|
_v = uid if uid is not None else _v
|
|
if _v is not None:
|
|
self["uid"] = _v
|
|
_v = arg.pop("uirevision", None)
|
|
_v = uirevision if uirevision is not None else _v
|
|
if _v is not None:
|
|
self["uirevision"] = _v
|
|
_v = arg.pop("unselected", None)
|
|
_v = unselected if unselected is not None else _v
|
|
if _v is not None:
|
|
self["unselected"] = _v
|
|
_v = arg.pop("visible", None)
|
|
_v = visible if visible is not None else _v
|
|
if _v is not None:
|
|
self["visible"] = _v
|
|
_v = arg.pop("width", None)
|
|
_v = width if width is not None else _v
|
|
if _v is not None:
|
|
self["width"] = _v
|
|
_v = arg.pop("widthsrc", None)
|
|
_v = widthsrc if widthsrc is not None else _v
|
|
if _v is not None:
|
|
self["widthsrc"] = _v
|
|
|
|
# Read-only literals
|
|
# ------------------
|
|
|
|
self._props["type"] = "barpolar"
|
|
arg.pop("type", None)
|
|
|
|
# Process unknown kwargs
|
|
# ----------------------
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
|
|
# Reset skip_invalid
|
|
# ------------------
|
|
self._skip_invalid = False
|