2302 lines
81 KiB
Python
2302 lines
81 KiB
Python
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
|
import copy as _copy
|
|
|
|
|
|
class Sunburst(_BaseTraceType):
|
|
|
|
# class properties
|
|
# --------------------
|
|
_parent_path_str = ""
|
|
_path_str = "sunburst"
|
|
_valid_props = {
|
|
"branchvalues",
|
|
"count",
|
|
"customdata",
|
|
"customdatasrc",
|
|
"domain",
|
|
"hoverinfo",
|
|
"hoverinfosrc",
|
|
"hoverlabel",
|
|
"hovertemplate",
|
|
"hovertemplatesrc",
|
|
"hovertext",
|
|
"hovertextsrc",
|
|
"ids",
|
|
"idssrc",
|
|
"insidetextfont",
|
|
"insidetextorientation",
|
|
"labels",
|
|
"labelssrc",
|
|
"leaf",
|
|
"legend",
|
|
"legendgrouptitle",
|
|
"legendrank",
|
|
"legendwidth",
|
|
"level",
|
|
"marker",
|
|
"maxdepth",
|
|
"meta",
|
|
"metasrc",
|
|
"name",
|
|
"opacity",
|
|
"outsidetextfont",
|
|
"parents",
|
|
"parentssrc",
|
|
"root",
|
|
"rotation",
|
|
"sort",
|
|
"stream",
|
|
"text",
|
|
"textfont",
|
|
"textinfo",
|
|
"textsrc",
|
|
"texttemplate",
|
|
"texttemplatesrc",
|
|
"type",
|
|
"uid",
|
|
"uirevision",
|
|
"values",
|
|
"valuessrc",
|
|
"visible",
|
|
}
|
|
|
|
# branchvalues
|
|
# ------------
|
|
@property
|
|
def branchvalues(self):
|
|
"""
|
|
Determines how the items in `values` are summed. When set to
|
|
"total", items in `values` are taken to be value of all its
|
|
descendants. When set to "remainder", items in `values`
|
|
corresponding to the root and the branches sectors are taken to
|
|
be the extra part not part of the sum of the values at their
|
|
leaves.
|
|
|
|
The 'branchvalues' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['remainder', 'total']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["branchvalues"]
|
|
|
|
@branchvalues.setter
|
|
def branchvalues(self, val):
|
|
self["branchvalues"] = val
|
|
|
|
# count
|
|
# -----
|
|
@property
|
|
def count(self):
|
|
"""
|
|
Determines default for `values` when it is not provided, by
|
|
inferring a 1 for each of the "leaves" and/or "branches",
|
|
otherwise 0.
|
|
|
|
The 'count' property is a flaglist and may be specified
|
|
as a string containing:
|
|
- Any combination of ['branches', 'leaves'] joined with '+' characters
|
|
(e.g. 'branches+leaves')
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["count"]
|
|
|
|
@count.setter
|
|
def count(self, val):
|
|
self["count"] = 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
|
|
|
|
# domain
|
|
# ------
|
|
@property
|
|
def domain(self):
|
|
"""
|
|
The 'domain' property is an instance of Domain
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.sunburst.Domain`
|
|
- A dict of string/value properties that will be passed
|
|
to the Domain constructor
|
|
|
|
Supported dict properties:
|
|
|
|
column
|
|
If there is a layout grid, use the domain for
|
|
this column in the grid for this sunburst trace
|
|
.
|
|
row
|
|
If there is a layout grid, use the domain for
|
|
this row in the grid for this sunburst trace .
|
|
x
|
|
Sets the horizontal domain of this sunburst
|
|
trace (in plot fraction).
|
|
y
|
|
Sets the vertical domain of this sunburst trace
|
|
(in plot fraction).
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.sunburst.Domain
|
|
"""
|
|
return self["domain"]
|
|
|
|
@domain.setter
|
|
def domain(self, val):
|
|
self["domain"] = 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 ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters
|
|
(e.g. 'label+text')
|
|
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.sunburst.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.sunburst.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. Finally, the
|
|
template string has access to variables `currentPath`, `root`,
|
|
`entry`, `percentRoot`, `percentEntry` and `percentParent`.
|
|
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):
|
|
"""
|
|
Sets hover text elements associated with each sector. If a
|
|
single string, the same string appears for all data points. If
|
|
an array of string, the items are mapped in order of this
|
|
trace's sectors. 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
|
|
|
|
# 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
|
|
|
|
# insidetextfont
|
|
# --------------
|
|
@property
|
|
def insidetextfont(self):
|
|
"""
|
|
Sets the font used for `textinfo` lying inside the sector.
|
|
|
|
The 'insidetextfont' property is an instance of Insidetextfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.sunburst.Insidetextfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Insidetextfont constructor
|
|
|
|
Supported dict properties:
|
|
|
|
color
|
|
|
|
colorsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `color`.
|
|
family
|
|
HTML font family - the typeface that will be
|
|
applied by the web browser. The web browser
|
|
will only be able to apply a font if it is
|
|
available on the system which it operates.
|
|
Provide multiple font families, separated by
|
|
commas, to indicate the preference in which to
|
|
apply fonts if they aren't available on the
|
|
system. The Chart Studio Cloud (at
|
|
https://chart-studio.plotly.com or on-premise)
|
|
generates images on a server, where only a
|
|
select number of fonts are installed and
|
|
supported. These include "Arial", "Balto",
|
|
"Courier New", "Droid Sans",, "Droid Serif",
|
|
"Droid Sans Mono", "Gravitas One", "Old
|
|
Standard TT", "Open Sans", "Overpass", "PT Sans
|
|
Narrow", "Raleway", "Times New Roman".
|
|
familysrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `family`.
|
|
size
|
|
|
|
sizesrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `size`.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.sunburst.Insidetextfont
|
|
"""
|
|
return self["insidetextfont"]
|
|
|
|
@insidetextfont.setter
|
|
def insidetextfont(self, val):
|
|
self["insidetextfont"] = val
|
|
|
|
# insidetextorientation
|
|
# ---------------------
|
|
@property
|
|
def insidetextorientation(self):
|
|
"""
|
|
Controls the orientation of the text inside chart sectors. When
|
|
set to "auto", text may be oriented in any direction in order
|
|
to be as big as possible in the middle of a sector. The
|
|
"horizontal" option orients text to be parallel with the bottom
|
|
of the chart, and may make text smaller in order to achieve
|
|
that goal. The "radial" option orients text along the radius of
|
|
the sector. The "tangential" option orients text perpendicular
|
|
to the radius of the sector.
|
|
|
|
The 'insidetextorientation' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['horizontal', 'radial', 'tangential', 'auto']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["insidetextorientation"]
|
|
|
|
@insidetextorientation.setter
|
|
def insidetextorientation(self, val):
|
|
self["insidetextorientation"] = val
|
|
|
|
# labels
|
|
# ------
|
|
@property
|
|
def labels(self):
|
|
"""
|
|
Sets the labels of each of the sectors.
|
|
|
|
The 'labels' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["labels"]
|
|
|
|
@labels.setter
|
|
def labels(self, val):
|
|
self["labels"] = val
|
|
|
|
# labelssrc
|
|
# ---------
|
|
@property
|
|
def labelssrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `labels`.
|
|
|
|
The 'labelssrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["labelssrc"]
|
|
|
|
@labelssrc.setter
|
|
def labelssrc(self, val):
|
|
self["labelssrc"] = val
|
|
|
|
# leaf
|
|
# ----
|
|
@property
|
|
def leaf(self):
|
|
"""
|
|
The 'leaf' property is an instance of Leaf
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.sunburst.Leaf`
|
|
- A dict of string/value properties that will be passed
|
|
to the Leaf constructor
|
|
|
|
Supported dict properties:
|
|
|
|
opacity
|
|
Sets the opacity of the leaves. With colorscale
|
|
it is defaulted to 1; otherwise it is defaulted
|
|
to 0.7
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.sunburst.Leaf
|
|
"""
|
|
return self["leaf"]
|
|
|
|
@leaf.setter
|
|
def leaf(self, val):
|
|
self["leaf"] = 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
|
|
|
|
# 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.sunburst.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.sunburst.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
|
|
|
|
# level
|
|
# -----
|
|
@property
|
|
def level(self):
|
|
"""
|
|
Sets the level from which this trace hierarchy is rendered. Set
|
|
`level` to `''` to start from the root node in the hierarchy.
|
|
Must be an "id" if `ids` is filled in, otherwise plotly
|
|
attempts to find a matching item in `labels`.
|
|
|
|
The 'level' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["level"]
|
|
|
|
@level.setter
|
|
def level(self, val):
|
|
self["level"] = 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.sunburst.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 colors 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
|
|
colors) or the bounds set in `marker.cmin` and
|
|
`marker.cmax` Has an effect only if colors 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 colors is set to a numerical
|
|
array. Value should have the same units as
|
|
colors 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 colors is set to a numerical array.
|
|
Value should have the same units as colors. Has
|
|
no effect when `marker.cauto` is `false`.
|
|
cmin
|
|
Sets the lower bound of the color domain. Has
|
|
an effect only if colors is set to a numerical
|
|
array. Value should have the same units as
|
|
colors and if set, `marker.cmax` must be set as
|
|
well.
|
|
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.sunburst.marker.Co
|
|
lorBar` instance or dict with compatible
|
|
properties
|
|
colors
|
|
Sets the color of each sector of this trace. If
|
|
not specified, the default trace color set is
|
|
used to pick the sector colors.
|
|
colorscale
|
|
Sets the colorscale. Has an effect only if
|
|
colors 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.
|
|
colorssrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `colors`.
|
|
line
|
|
:class:`plotly.graph_objects.sunburst.marker.Li
|
|
ne` instance or dict with compatible properties
|
|
pattern
|
|
Sets the pattern within the marker.
|
|
reversescale
|
|
Reverses the color mapping if true. Has an
|
|
effect only if colors 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
|
|
colors is set to a numerical array.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.sunburst.Marker
|
|
"""
|
|
return self["marker"]
|
|
|
|
@marker.setter
|
|
def marker(self, val):
|
|
self["marker"] = val
|
|
|
|
# maxdepth
|
|
# --------
|
|
@property
|
|
def maxdepth(self):
|
|
"""
|
|
Sets the number of rendered sectors from any given `level`. Set
|
|
`maxdepth` to "-1" to render all the levels in the hierarchy.
|
|
|
|
The 'maxdepth' property is a integer and may be specified as:
|
|
- An int (or float that will be cast to an int)
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
"""
|
|
return self["maxdepth"]
|
|
|
|
@maxdepth.setter
|
|
def maxdepth(self, val):
|
|
self["maxdepth"] = 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
|
|
|
|
# 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
|
|
|
|
# outsidetextfont
|
|
# ---------------
|
|
@property
|
|
def outsidetextfont(self):
|
|
"""
|
|
Sets the font used for `textinfo` lying outside the sector.
|
|
This option refers to the root of the hierarchy presented at
|
|
the center of a sunburst graph. Please note that if a hierarchy
|
|
has multiple root nodes, this option won't have any effect and
|
|
`insidetextfont` would be used.
|
|
|
|
The 'outsidetextfont' property is an instance of Outsidetextfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.sunburst.Outsidetextfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Outsidetextfont constructor
|
|
|
|
Supported dict properties:
|
|
|
|
color
|
|
|
|
colorsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `color`.
|
|
family
|
|
HTML font family - the typeface that will be
|
|
applied by the web browser. The web browser
|
|
will only be able to apply a font if it is
|
|
available on the system which it operates.
|
|
Provide multiple font families, separated by
|
|
commas, to indicate the preference in which to
|
|
apply fonts if they aren't available on the
|
|
system. The Chart Studio Cloud (at
|
|
https://chart-studio.plotly.com or on-premise)
|
|
generates images on a server, where only a
|
|
select number of fonts are installed and
|
|
supported. These include "Arial", "Balto",
|
|
"Courier New", "Droid Sans",, "Droid Serif",
|
|
"Droid Sans Mono", "Gravitas One", "Old
|
|
Standard TT", "Open Sans", "Overpass", "PT Sans
|
|
Narrow", "Raleway", "Times New Roman".
|
|
familysrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `family`.
|
|
size
|
|
|
|
sizesrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `size`.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.sunburst.Outsidetextfont
|
|
"""
|
|
return self["outsidetextfont"]
|
|
|
|
@outsidetextfont.setter
|
|
def outsidetextfont(self, val):
|
|
self["outsidetextfont"] = val
|
|
|
|
# parents
|
|
# -------
|
|
@property
|
|
def parents(self):
|
|
"""
|
|
Sets the parent sectors for each of the sectors. Empty string
|
|
items '' are understood to reference the root node in the
|
|
hierarchy. If `ids` is filled, `parents` items are understood
|
|
to be "ids" themselves. When `ids` is not set, plotly attempts
|
|
to find matching items in `labels`, but beware they must be
|
|
unique.
|
|
|
|
The 'parents' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["parents"]
|
|
|
|
@parents.setter
|
|
def parents(self, val):
|
|
self["parents"] = val
|
|
|
|
# parentssrc
|
|
# ----------
|
|
@property
|
|
def parentssrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `parents`.
|
|
|
|
The 'parentssrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["parentssrc"]
|
|
|
|
@parentssrc.setter
|
|
def parentssrc(self, val):
|
|
self["parentssrc"] = val
|
|
|
|
# root
|
|
# ----
|
|
@property
|
|
def root(self):
|
|
"""
|
|
The 'root' property is an instance of Root
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.sunburst.Root`
|
|
- A dict of string/value properties that will be passed
|
|
to the Root constructor
|
|
|
|
Supported dict properties:
|
|
|
|
color
|
|
sets the color of the root node for a
|
|
sunburst/treemap/icicle trace. this has no
|
|
effect when a colorscale is used to set the
|
|
markers.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.sunburst.Root
|
|
"""
|
|
return self["root"]
|
|
|
|
@root.setter
|
|
def root(self, val):
|
|
self["root"] = val
|
|
|
|
# rotation
|
|
# --------
|
|
@property
|
|
def rotation(self):
|
|
"""
|
|
Rotates the whole diagram counterclockwise by some angle. By
|
|
default the first slice starts at 3 o'clock.
|
|
|
|
The 'rotation' 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["rotation"]
|
|
|
|
@rotation.setter
|
|
def rotation(self, val):
|
|
self["rotation"] = val
|
|
|
|
# sort
|
|
# ----
|
|
@property
|
|
def sort(self):
|
|
"""
|
|
Determines whether or not the sectors are reordered from
|
|
largest to smallest.
|
|
|
|
The 'sort' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["sort"]
|
|
|
|
@sort.setter
|
|
def sort(self, val):
|
|
self["sort"] = 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.sunburst.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.sunburst.Stream
|
|
"""
|
|
return self["stream"]
|
|
|
|
@stream.setter
|
|
def stream(self, val):
|
|
self["stream"] = val
|
|
|
|
# text
|
|
# ----
|
|
@property
|
|
def text(self):
|
|
"""
|
|
Sets text elements associated with each sector. If trace
|
|
`textinfo` contains a "text" flag, these elements will be seen
|
|
on the chart. 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 an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["text"]
|
|
|
|
@text.setter
|
|
def text(self, val):
|
|
self["text"] = val
|
|
|
|
# textfont
|
|
# --------
|
|
@property
|
|
def textfont(self):
|
|
"""
|
|
Sets the font used for `textinfo`.
|
|
|
|
The 'textfont' property is an instance of Textfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.sunburst.Textfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Textfont constructor
|
|
|
|
Supported dict properties:
|
|
|
|
color
|
|
|
|
colorsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `color`.
|
|
family
|
|
HTML font family - the typeface that will be
|
|
applied by the web browser. The web browser
|
|
will only be able to apply a font if it is
|
|
available on the system which it operates.
|
|
Provide multiple font families, separated by
|
|
commas, to indicate the preference in which to
|
|
apply fonts if they aren't available on the
|
|
system. The Chart Studio Cloud (at
|
|
https://chart-studio.plotly.com or on-premise)
|
|
generates images on a server, where only a
|
|
select number of fonts are installed and
|
|
supported. These include "Arial", "Balto",
|
|
"Courier New", "Droid Sans",, "Droid Serif",
|
|
"Droid Sans Mono", "Gravitas One", "Old
|
|
Standard TT", "Open Sans", "Overpass", "PT Sans
|
|
Narrow", "Raleway", "Times New Roman".
|
|
familysrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `family`.
|
|
size
|
|
|
|
sizesrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `size`.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.sunburst.Textfont
|
|
"""
|
|
return self["textfont"]
|
|
|
|
@textfont.setter
|
|
def textfont(self, val):
|
|
self["textfont"] = val
|
|
|
|
# textinfo
|
|
# --------
|
|
@property
|
|
def textinfo(self):
|
|
"""
|
|
Determines which trace information appear on the graph.
|
|
|
|
The 'textinfo' property is a flaglist and may be specified
|
|
as a string containing:
|
|
- Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] 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
|
|
|
|
# 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
|
|
|
|
# texttemplate
|
|
# ------------
|
|
@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
|
|
`currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`,
|
|
`percentParent`, `label` and `value`.
|
|
|
|
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
|
|
|
|
# texttemplatesrc
|
|
# ---------------
|
|
@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
|
|
|
|
# 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
|
|
|
|
# values
|
|
# ------
|
|
@property
|
|
def values(self):
|
|
"""
|
|
Sets the values associated with each of the sectors. Use with
|
|
`branchvalues` to determine how the values are summed.
|
|
|
|
The 'values' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["values"]
|
|
|
|
@values.setter
|
|
def values(self, val):
|
|
self["values"] = val
|
|
|
|
# valuessrc
|
|
# ---------
|
|
@property
|
|
def valuessrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `values`.
|
|
|
|
The 'valuessrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["valuessrc"]
|
|
|
|
@valuessrc.setter
|
|
def valuessrc(self, val):
|
|
self["valuessrc"] = 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
|
|
|
|
# type
|
|
# ----
|
|
@property
|
|
def type(self):
|
|
return self._props["type"]
|
|
|
|
# Self properties description
|
|
# ---------------------------
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
branchvalues
|
|
Determines how the items in `values` are summed. When
|
|
set to "total", items in `values` are taken to be value
|
|
of all its descendants. When set to "remainder", items
|
|
in `values` corresponding to the root and the branches
|
|
sectors are taken to be the extra part not part of the
|
|
sum of the values at their leaves.
|
|
count
|
|
Determines default for `values` when it is not
|
|
provided, by inferring a 1 for each of the "leaves"
|
|
and/or "branches", otherwise 0.
|
|
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`.
|
|
domain
|
|
:class:`plotly.graph_objects.sunburst.Domain` instance
|
|
or dict with compatible properties
|
|
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.sunburst.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 `currentPath`, `root`, `entry`,
|
|
`percentRoot`, `percentEntry` and `percentParent`.
|
|
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 sector.
|
|
If a single string, the same string appears for all
|
|
data points. If an array of string, the items are
|
|
mapped in order of this trace's sectors. 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`.
|
|
insidetextfont
|
|
Sets the font used for `textinfo` lying inside the
|
|
sector.
|
|
insidetextorientation
|
|
Controls the orientation of the text inside chart
|
|
sectors. When set to "auto", text may be oriented in
|
|
any direction in order to be as big as possible in the
|
|
middle of a sector. The "horizontal" option orients
|
|
text to be parallel with the bottom of the chart, and
|
|
may make text smaller in order to achieve that goal.
|
|
The "radial" option orients text along the radius of
|
|
the sector. The "tangential" option orients text
|
|
perpendicular to the radius of the sector.
|
|
labels
|
|
Sets the labels of each of the sectors.
|
|
labelssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`labels`.
|
|
leaf
|
|
:class:`plotly.graph_objects.sunburst.Leaf` instance or
|
|
dict with compatible properties
|
|
legend
|
|
Sets the reference to a legend to show this trace in.
|
|
References to these legends are "legend", "legend2",
|
|
"legend3", etc. Settings for these legends are set in
|
|
the layout, under `layout.legend`, `layout.legend2`,
|
|
etc.
|
|
legendgrouptitle
|
|
:class:`plotly.graph_objects.sunburst.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.
|
|
level
|
|
Sets the level from which this trace hierarchy is
|
|
rendered. Set `level` to `''` to start from the root
|
|
node in the hierarchy. Must be an "id" if `ids` is
|
|
filled in, otherwise plotly attempts to find a matching
|
|
item in `labels`.
|
|
marker
|
|
:class:`plotly.graph_objects.sunburst.Marker` instance
|
|
or dict with compatible properties
|
|
maxdepth
|
|
Sets the number of rendered sectors from any given
|
|
`level`. Set `maxdepth` to "-1" to render all the
|
|
levels in the hierarchy.
|
|
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.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
outsidetextfont
|
|
Sets the font used for `textinfo` lying outside the
|
|
sector. This option refers to the root of the hierarchy
|
|
presented at the center of a sunburst graph. Please
|
|
note that if a hierarchy has multiple root nodes, this
|
|
option won't have any effect and `insidetextfont` would
|
|
be used.
|
|
parents
|
|
Sets the parent sectors for each of the sectors. Empty
|
|
string items '' are understood to reference the root
|
|
node in the hierarchy. If `ids` is filled, `parents`
|
|
items are understood to be "ids" themselves. When `ids`
|
|
is not set, plotly attempts to find matching items in
|
|
`labels`, but beware they must be unique.
|
|
parentssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`parents`.
|
|
root
|
|
:class:`plotly.graph_objects.sunburst.Root` instance or
|
|
dict with compatible properties
|
|
rotation
|
|
Rotates the whole diagram counterclockwise by some
|
|
angle. By default the first slice starts at 3 o'clock.
|
|
sort
|
|
Determines whether or not the sectors are reordered
|
|
from largest to smallest.
|
|
stream
|
|
:class:`plotly.graph_objects.sunburst.Stream` instance
|
|
or dict with compatible properties
|
|
text
|
|
Sets text elements associated with each sector. If
|
|
trace `textinfo` contains a "text" flag, these elements
|
|
will be seen on the chart. If trace `hoverinfo`
|
|
contains a "text" flag and "hovertext" is not set,
|
|
these elements will be seen in the hover labels.
|
|
textfont
|
|
Sets the font used for `textinfo`.
|
|
textinfo
|
|
Determines which trace information appear on the graph.
|
|
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 `currentPath`, `root`, `entry`,
|
|
`percentRoot`, `percentEntry`, `percentParent`, `label`
|
|
and `value`.
|
|
texttemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`texttemplate`.
|
|
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.
|
|
values
|
|
Sets the values associated with each of the sectors.
|
|
Use with `branchvalues` to determine how the values are
|
|
summed.
|
|
valuessrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`values`.
|
|
visible
|
|
Determines whether or not this trace is visible. If
|
|
"legendonly", the trace is not drawn, but can appear as
|
|
a legend item (provided that the legend itself is
|
|
visible).
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
arg=None,
|
|
branchvalues=None,
|
|
count=None,
|
|
customdata=None,
|
|
customdatasrc=None,
|
|
domain=None,
|
|
hoverinfo=None,
|
|
hoverinfosrc=None,
|
|
hoverlabel=None,
|
|
hovertemplate=None,
|
|
hovertemplatesrc=None,
|
|
hovertext=None,
|
|
hovertextsrc=None,
|
|
ids=None,
|
|
idssrc=None,
|
|
insidetextfont=None,
|
|
insidetextorientation=None,
|
|
labels=None,
|
|
labelssrc=None,
|
|
leaf=None,
|
|
legend=None,
|
|
legendgrouptitle=None,
|
|
legendrank=None,
|
|
legendwidth=None,
|
|
level=None,
|
|
marker=None,
|
|
maxdepth=None,
|
|
meta=None,
|
|
metasrc=None,
|
|
name=None,
|
|
opacity=None,
|
|
outsidetextfont=None,
|
|
parents=None,
|
|
parentssrc=None,
|
|
root=None,
|
|
rotation=None,
|
|
sort=None,
|
|
stream=None,
|
|
text=None,
|
|
textfont=None,
|
|
textinfo=None,
|
|
textsrc=None,
|
|
texttemplate=None,
|
|
texttemplatesrc=None,
|
|
uid=None,
|
|
uirevision=None,
|
|
values=None,
|
|
valuessrc=None,
|
|
visible=None,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
Construct a new Sunburst object
|
|
|
|
Visualize hierarchal data spanning outward radially from root
|
|
to leaves. The sunburst sectors are determined by the entries
|
|
in "labels" or "ids" and in "parents".
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of :class:`plotly.graph_objs.Sunburst`
|
|
branchvalues
|
|
Determines how the items in `values` are summed. When
|
|
set to "total", items in `values` are taken to be value
|
|
of all its descendants. When set to "remainder", items
|
|
in `values` corresponding to the root and the branches
|
|
sectors are taken to be the extra part not part of the
|
|
sum of the values at their leaves.
|
|
count
|
|
Determines default for `values` when it is not
|
|
provided, by inferring a 1 for each of the "leaves"
|
|
and/or "branches", otherwise 0.
|
|
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`.
|
|
domain
|
|
:class:`plotly.graph_objects.sunburst.Domain` instance
|
|
or dict with compatible properties
|
|
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.sunburst.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 `currentPath`, `root`, `entry`,
|
|
`percentRoot`, `percentEntry` and `percentParent`.
|
|
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 sector.
|
|
If a single string, the same string appears for all
|
|
data points. If an array of string, the items are
|
|
mapped in order of this trace's sectors. 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`.
|
|
insidetextfont
|
|
Sets the font used for `textinfo` lying inside the
|
|
sector.
|
|
insidetextorientation
|
|
Controls the orientation of the text inside chart
|
|
sectors. When set to "auto", text may be oriented in
|
|
any direction in order to be as big as possible in the
|
|
middle of a sector. The "horizontal" option orients
|
|
text to be parallel with the bottom of the chart, and
|
|
may make text smaller in order to achieve that goal.
|
|
The "radial" option orients text along the radius of
|
|
the sector. The "tangential" option orients text
|
|
perpendicular to the radius of the sector.
|
|
labels
|
|
Sets the labels of each of the sectors.
|
|
labelssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`labels`.
|
|
leaf
|
|
:class:`plotly.graph_objects.sunburst.Leaf` instance or
|
|
dict with compatible properties
|
|
legend
|
|
Sets the reference to a legend to show this trace in.
|
|
References to these legends are "legend", "legend2",
|
|
"legend3", etc. Settings for these legends are set in
|
|
the layout, under `layout.legend`, `layout.legend2`,
|
|
etc.
|
|
legendgrouptitle
|
|
:class:`plotly.graph_objects.sunburst.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.
|
|
level
|
|
Sets the level from which this trace hierarchy is
|
|
rendered. Set `level` to `''` to start from the root
|
|
node in the hierarchy. Must be an "id" if `ids` is
|
|
filled in, otherwise plotly attempts to find a matching
|
|
item in `labels`.
|
|
marker
|
|
:class:`plotly.graph_objects.sunburst.Marker` instance
|
|
or dict with compatible properties
|
|
maxdepth
|
|
Sets the number of rendered sectors from any given
|
|
`level`. Set `maxdepth` to "-1" to render all the
|
|
levels in the hierarchy.
|
|
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.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
outsidetextfont
|
|
Sets the font used for `textinfo` lying outside the
|
|
sector. This option refers to the root of the hierarchy
|
|
presented at the center of a sunburst graph. Please
|
|
note that if a hierarchy has multiple root nodes, this
|
|
option won't have any effect and `insidetextfont` would
|
|
be used.
|
|
parents
|
|
Sets the parent sectors for each of the sectors. Empty
|
|
string items '' are understood to reference the root
|
|
node in the hierarchy. If `ids` is filled, `parents`
|
|
items are understood to be "ids" themselves. When `ids`
|
|
is not set, plotly attempts to find matching items in
|
|
`labels`, but beware they must be unique.
|
|
parentssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`parents`.
|
|
root
|
|
:class:`plotly.graph_objects.sunburst.Root` instance or
|
|
dict with compatible properties
|
|
rotation
|
|
Rotates the whole diagram counterclockwise by some
|
|
angle. By default the first slice starts at 3 o'clock.
|
|
sort
|
|
Determines whether or not the sectors are reordered
|
|
from largest to smallest.
|
|
stream
|
|
:class:`plotly.graph_objects.sunburst.Stream` instance
|
|
or dict with compatible properties
|
|
text
|
|
Sets text elements associated with each sector. If
|
|
trace `textinfo` contains a "text" flag, these elements
|
|
will be seen on the chart. If trace `hoverinfo`
|
|
contains a "text" flag and "hovertext" is not set,
|
|
these elements will be seen in the hover labels.
|
|
textfont
|
|
Sets the font used for `textinfo`.
|
|
textinfo
|
|
Determines which trace information appear on the graph.
|
|
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 `currentPath`, `root`, `entry`,
|
|
`percentRoot`, `percentEntry`, `percentParent`, `label`
|
|
and `value`.
|
|
texttemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`texttemplate`.
|
|
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.
|
|
values
|
|
Sets the values associated with each of the sectors.
|
|
Use with `branchvalues` to determine how the values are
|
|
summed.
|
|
valuessrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`values`.
|
|
visible
|
|
Determines whether or not this trace is visible. If
|
|
"legendonly", the trace is not drawn, but can appear as
|
|
a legend item (provided that the legend itself is
|
|
visible).
|
|
|
|
Returns
|
|
-------
|
|
Sunburst
|
|
"""
|
|
super(Sunburst, self).__init__("sunburst")
|
|
|
|
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.Sunburst
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.Sunburst`"""
|
|
)
|
|
|
|
# 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("branchvalues", None)
|
|
_v = branchvalues if branchvalues is not None else _v
|
|
if _v is not None:
|
|
self["branchvalues"] = _v
|
|
_v = arg.pop("count", None)
|
|
_v = count if count is not None else _v
|
|
if _v is not None:
|
|
self["count"] = _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("domain", None)
|
|
_v = domain if domain is not None else _v
|
|
if _v is not None:
|
|
self["domain"] = _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("insidetextfont", None)
|
|
_v = insidetextfont if insidetextfont is not None else _v
|
|
if _v is not None:
|
|
self["insidetextfont"] = _v
|
|
_v = arg.pop("insidetextorientation", None)
|
|
_v = insidetextorientation if insidetextorientation is not None else _v
|
|
if _v is not None:
|
|
self["insidetextorientation"] = _v
|
|
_v = arg.pop("labels", None)
|
|
_v = labels if labels is not None else _v
|
|
if _v is not None:
|
|
self["labels"] = _v
|
|
_v = arg.pop("labelssrc", None)
|
|
_v = labelssrc if labelssrc is not None else _v
|
|
if _v is not None:
|
|
self["labelssrc"] = _v
|
|
_v = arg.pop("leaf", None)
|
|
_v = leaf if leaf is not None else _v
|
|
if _v is not None:
|
|
self["leaf"] = _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("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("level", None)
|
|
_v = level if level is not None else _v
|
|
if _v is not None:
|
|
self["level"] = _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("maxdepth", None)
|
|
_v = maxdepth if maxdepth is not None else _v
|
|
if _v is not None:
|
|
self["maxdepth"] = _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("opacity", None)
|
|
_v = opacity if opacity is not None else _v
|
|
if _v is not None:
|
|
self["opacity"] = _v
|
|
_v = arg.pop("outsidetextfont", None)
|
|
_v = outsidetextfont if outsidetextfont is not None else _v
|
|
if _v is not None:
|
|
self["outsidetextfont"] = _v
|
|
_v = arg.pop("parents", None)
|
|
_v = parents if parents is not None else _v
|
|
if _v is not None:
|
|
self["parents"] = _v
|
|
_v = arg.pop("parentssrc", None)
|
|
_v = parentssrc if parentssrc is not None else _v
|
|
if _v is not None:
|
|
self["parentssrc"] = _v
|
|
_v = arg.pop("root", None)
|
|
_v = root if root is not None else _v
|
|
if _v is not None:
|
|
self["root"] = _v
|
|
_v = arg.pop("rotation", None)
|
|
_v = rotation if rotation is not None else _v
|
|
if _v is not None:
|
|
self["rotation"] = _v
|
|
_v = arg.pop("sort", None)
|
|
_v = sort if sort is not None else _v
|
|
if _v is not None:
|
|
self["sort"] = _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("text", None)
|
|
_v = text if text is not None else _v
|
|
if _v is not None:
|
|
self["text"] = _v
|
|
_v = arg.pop("textfont", None)
|
|
_v = textfont if textfont is not None else _v
|
|
if _v is not None:
|
|
self["textfont"] = _v
|
|
_v = arg.pop("textinfo", None)
|
|
_v = textinfo if textinfo is not None else _v
|
|
if _v is not None:
|
|
self["textinfo"] = _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("texttemplate", None)
|
|
_v = texttemplate if texttemplate is not None else _v
|
|
if _v is not None:
|
|
self["texttemplate"] = _v
|
|
_v = arg.pop("texttemplatesrc", None)
|
|
_v = texttemplatesrc if texttemplatesrc is not None else _v
|
|
if _v is not None:
|
|
self["texttemplatesrc"] = _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("values", None)
|
|
_v = values if values is not None else _v
|
|
if _v is not None:
|
|
self["values"] = _v
|
|
_v = arg.pop("valuessrc", None)
|
|
_v = valuessrc if valuessrc is not None else _v
|
|
if _v is not None:
|
|
self["valuessrc"] = _v
|
|
_v = arg.pop("visible", None)
|
|
_v = visible if visible is not None else _v
|
|
if _v is not None:
|
|
self["visible"] = _v
|
|
|
|
# Read-only literals
|
|
# ------------------
|
|
|
|
self._props["type"] = "sunburst"
|
|
arg.pop("type", None)
|
|
|
|
# Process unknown kwargs
|
|
# ----------------------
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
|
|
# Reset skip_invalid
|
|
# ------------------
|
|
self._skip_invalid = False
|