plotly.graph_objects
.Sunburst¶
-
class
plotly.graph_objects.
Sunburst
(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)¶ -
__init__
(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
plotly.graph_objects.Sunburst
branchvalues – Determines how the items in
values
are summed. When set to “total”, items invalues
are taken to be value of all its descendants. When set to “remainder”, items invalues
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 –
plotly.graph_objects.sunburst.Domain
instance or dict with compatible propertieshoverinfo – Determines which trace information appear on hover. If
none
orskip
are set, no information is displayed upon hovering. But, ifnone
is set, click and hover events are still fired.hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo
.hoverlabel –
plotly.graph_objects.sunburst.Hoverlabel
instance or dict with compatible propertieshovertemplate – 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 inhovertemplate
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 arearrayOk: true
) are available. Finally, the template string has access to variablescurrentPath
,root
,entry
,percentRoot
,percentEntry
andpercentParent
. 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 –
plotly.graph_objects.sunburst.Leaf
instance or dict with compatible propertieslegend – 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 –
plotly.graph_objects.sunburst.Legendgrouptitle
instance or dict with compatible propertieslegendrank – 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” ifids
is filled in, otherwise plotly attempts to find a matching item inlabels
.marker –
plotly.graph_objects.sunburst.Marker
instance or dict with compatible propertiesmaxdepth – Sets the number of rendered sectors from any given
level
. Setmaxdepth
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 colorbartitle.text
, annotationtext
rangeselector
,updatemenues
andsliders
label
text all supportmeta
. To access the tracemeta
values in an attribute in the same trace, simply use%{meta[i]}
wherei
is the index or key of themeta
item in question. To access tracemeta
in layout attributes, use%{data[n[.meta[i]}
wherei
is the index or key of themeta
andn
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 andinsidetextfont
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. Whenids
is not set, plotly attempts to find matching items inlabels
, but beware they must be unique.parentssrc – Sets the source reference on Chart Studio Cloud for
parents
.root –
plotly.graph_objects.sunburst.Root
instance or dict with compatible propertiesrotation – 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 –
plotly.graph_objects.sunburst.Stream
instance or dict with compatible propertiestext – Sets text elements associated with each sector. If trace
textinfo
contains a “text” flag, these elements will be seen on the chart. If tracehoverinfo
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 arearrayOk: true
) are available. Finally, the template string has access to variablescurrentPath
,root
,entry
,percentRoot
,percentEntry
,percentParent
,label
andvalue
.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
inparcoords
traces, as well as someeditable: true
modifications such asname
andcolorbar.title
. Defaults tolayout.uirevision
. Note that other user-driven trace attribute changes are controlled bylayout
attributes:trace.visible
is controlled bylayout.legend.uirevision
,selectedpoints
is controlled bylayout.selectionrevision
, andcolorbar.(x|y)
(accessible withconfig: {editable: true}
) is controlled bylayout.editrevision
. Trace changes are tracked byuid
, which only falls back on trace index if nouid
is provided. So if your app can add/remove traces before the end of thedata
array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace auid
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
- Return type
-
plotly.graph_objects
.sunburst¶
-
class
plotly.graph_objects.sunburst.
Domain
(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶ -
property
column
¶ If there is a layout grid, use the domain for this column in the grid for this sunburst trace .
- The ‘column’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
- Returns
- Return type
-
property
row
¶ If there is a layout grid, use the domain for this row in the grid for this sunburst trace .
- The ‘row’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
- Returns
- Return type
-
property
x
¶ - Sets the horizontal domain of this sunburst trace (in plot
fraction).
The ‘x’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
- The ‘x[0]’ property is a number and may be specified as:
An int or float in the interval [0, 1]
- The ‘x[1]’ property is a number and may be specified as:
An int or float in the interval [0, 1]
list
-
property
y
¶ - Sets the vertical domain of this sunburst trace (in plot
fraction).
The ‘y’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
- The ‘y[0]’ property is a number and may be specified as:
An int or float in the interval [0, 1]
- The ‘y[1]’ property is a number and may be specified as:
An int or float in the interval [0, 1]
list
-
property
-
class
plotly.graph_objects.sunburst.
Hoverlabel
(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, **kwargs)¶ -
property
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
- The ‘align’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘right’, ‘auto’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
alignsrc
¶ Sets the source reference on Chart Studio Cloud for
align
.The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
bgcolor
¶ Sets the background color of the hover labels for this trace
- The ‘bgcolor’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
bgcolorsrc
¶ Sets the source reference on Chart Studio Cloud for
bgcolor
.The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
bordercolor
¶ Sets the border color of the hover labels for this trace.
- The ‘bordercolor’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
bordercolorsrc
¶ Sets the source reference on Chart Studio Cloud for
bordercolor
.The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
font
¶ Sets the font used in hover labels.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.sunburst.hoverlabel.Font
A dict of string/value properties that will be passed to the Font constructor
- Returns
- Return type
-
property
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.- The ‘namelength’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|numpy.ndarray
-
property
-
class
plotly.graph_objects.sunburst.
Insidetextfont
(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)¶ -
property
color
¶ - The ‘color’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
colorsrc
¶ Sets the source reference on Chart Studio Cloud for
color
.The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
family
¶ HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.
- The ‘family’ property is a string and must be specified as:
A non-empty string
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
str|numpy.ndarray
-
property
familysrc
¶ Sets the source reference on Chart Studio Cloud for
family
.The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
lineposition
¶ Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
A list or array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
linepositionsrc
¶ Sets the source reference on Chart Studio Cloud for
lineposition
.The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
shadow
¶ Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
- The ‘shadow’ 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
- Return type
str|numpy.ndarray
-
property
shadowsrc
¶ Sets the source reference on Chart Studio Cloud for
shadow
.The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
size
¶ - The ‘size’ property is a number and may be specified as:
An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|float|numpy.ndarray
-
property
sizesrc
¶ Sets the source reference on Chart Studio Cloud for
size
.The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
style
¶ Sets whether a font should be styled with a normal or italic face from its family.
- The ‘style’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
stylesrc
¶ Sets the source reference on Chart Studio Cloud for
style
.The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
textcase
¶ Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- The ‘textcase’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
textcasesrc
¶ Sets the source reference on Chart Studio Cloud for
textcase
.The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
variant
¶ Sets the variant of the font.
- The ‘variant’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
variantsrc
¶ Sets the source reference on Chart Studio Cloud for
variant
.The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
weight
¶ Sets the weight (or boldness) of the font.
- The ‘weight’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|numpy.ndarray
-
property
-
class
plotly.graph_objects.sunburst.
Leaf
(arg=None, opacity=None, **kwargs)¶ -
property
opacity
¶ Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7
- The ‘opacity’ property is a number and may be specified as:
An int or float in the interval [0, 1]
- Returns
- Return type
int|float
-
property
-
class
plotly.graph_objects.sunburst.
Legendgrouptitle
(arg=None, font=None, text=None, **kwargs)¶ -
property
font
¶ Sets this legend group’s title font.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.sunburst.legendgrouptitle.Font
A dict of string/value properties that will be passed to the Font constructor
- Returns
- Return type
-
property
-
class
plotly.graph_objects.sunburst.
Marker
(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colors=None, colorscale=None, colorssrc=None, line=None, pattern=None, reversescale=None, showscale=None, **kwargs)¶ -
property
autocolorscale
¶ Determines whether the colorscale is a default palette (
autocolorscale: true
) or the palette determined bymarker.colorscale
. Has an effect only if colors is set to a numerical array. In casecolorscale
is unspecified orautocolorscale
is true, the default palette will be chosen according to whether numbers in thecolor
array are all positive, all negative or mixed.The ‘autocolorscale’ property must be specified as a bool (either True, or False)
- Returns
- Return type
-
property
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
andmarker.cmax
Has an effect only if colors is set to a numerical array. Defaults tofalse
whenmarker.cmin
andmarker.cmax
are set by the user.The ‘cauto’ property must be specified as a bool (either True, or False)
- Returns
- Return type
-
property
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.- The ‘cmax’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
cmid
¶ Sets the mid-point of the color domain by scaling
marker.cmin
and/ormarker.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 whenmarker.cauto
isfalse
.- The ‘cmid’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
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.- The ‘cmin’ property is a number and may be specified as:
An int or float
- Returns
- Return type
int|float
-
property
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.The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)
- Returns
- Return type
-
property
colorbar
¶ The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.sunburst.marker.ColorBar
A dict of string/value properties that will be passed to the ColorBar constructor
- Returns
- Return type
-
property
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.
The ‘colors’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
- Returns
- Return type
numpy.ndarray
-
property
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, usemarker.cmin
andmarker.cmax
. Alternatively,colorscale
may be a palette name string of the following list: Blackbody,Bluered,Blues,Civi dis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow ,RdBu,Reds,Viridis,YlGnBu,YlOrRd.The ‘colorscale’ property is a colorscale and may be specified as:
A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.
A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])
- One of the following named colorscales:
- [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].
Appending ‘_r’ to a named colorscale reverses it.
- Returns
- Return type
-
property
colorssrc
¶ Sets the source reference on Chart Studio Cloud for
colors
.The ‘colorssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
line
¶ The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.sunburst.marker.Line
A dict of string/value properties that will be passed to the Line constructor
- Returns
- Return type
-
property
pattern
¶ Sets the pattern within the marker.
The ‘pattern’ property is an instance of Pattern that may be specified as:
An instance of
plotly.graph_objects.sunburst.marker.Pattern
A dict of string/value properties that will be passed to the Pattern constructor
- Returns
- Return type
-
property
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 andmarker.cmax
will correspond to the first color.The ‘reversescale’ property must be specified as a bool (either True, or False)
- Returns
- Return type
-
property
-
class
plotly.graph_objects.sunburst.
Outsidetextfont
(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)¶ -
property
color
¶ - The ‘color’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
colorsrc
¶ Sets the source reference on Chart Studio Cloud for
color
.The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
family
¶ HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.
- The ‘family’ property is a string and must be specified as:
A non-empty string
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
str|numpy.ndarray
-
property
familysrc
¶ Sets the source reference on Chart Studio Cloud for
family
.The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
lineposition
¶ Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
A list or array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
linepositionsrc
¶ Sets the source reference on Chart Studio Cloud for
lineposition
.The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
shadow
¶ Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
- The ‘shadow’ 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
- Return type
str|numpy.ndarray
-
property
shadowsrc
¶ Sets the source reference on Chart Studio Cloud for
shadow
.The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
size
¶ - The ‘size’ property is a number and may be specified as:
An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|float|numpy.ndarray
-
property
sizesrc
¶ Sets the source reference on Chart Studio Cloud for
size
.The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
style
¶ Sets whether a font should be styled with a normal or italic face from its family.
- The ‘style’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
stylesrc
¶ Sets the source reference on Chart Studio Cloud for
style
.The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
textcase
¶ Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- The ‘textcase’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
textcasesrc
¶ Sets the source reference on Chart Studio Cloud for
textcase
.The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
variant
¶ Sets the variant of the font.
- The ‘variant’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
variantsrc
¶ Sets the source reference on Chart Studio Cloud for
variant
.The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
weight
¶ Sets the weight (or boldness) of the font.
- The ‘weight’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|numpy.ndarray
-
property
-
class
plotly.graph_objects.sunburst.
Root
(arg=None, color=None, **kwargs)¶ -
property
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.
- The ‘color’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
- Returns
- Return type
-
property
-
class
plotly.graph_objects.sunburst.
Stream
(arg=None, maxpoints=None, token=None, **kwargs)¶ -
property
maxpoints
¶ Sets the maximum number of points to keep on the plots from an incoming stream. If
maxpoints
is set to 50, only the newest 50 points will be displayed on the plot.- The ‘maxpoints’ property is a number and may be specified as:
An int or float in the interval [0, 10000]
- Returns
- Return type
int|float
-
property
token
¶ The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.
- The ‘token’ property is a string and must be specified as:
A non-empty string
- Returns
- Return type
-
property
-
class
plotly.graph_objects.sunburst.
Textfont
(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)¶ -
property
color
¶ - The ‘color’ property is a color and may be specified as:
A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color: see https://plotly.com/python/css-colors/ for a list
A list or array of any of the above
- Returns
- Return type
str|numpy.ndarray
-
property
colorsrc
¶ Sets the source reference on Chart Studio Cloud for
color
.The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
family
¶ HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.
- The ‘family’ property is a string and must be specified as:
A non-empty string
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
str|numpy.ndarray
-
property
familysrc
¶ Sets the source reference on Chart Studio Cloud for
family
.The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
lineposition
¶ Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
The ‘lineposition’ property is a flaglist and may be specified as a string containing:
Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)
A list or array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
linepositionsrc
¶ Sets the source reference on Chart Studio Cloud for
lineposition
.The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
shadow
¶ Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.
- The ‘shadow’ 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
- Return type
str|numpy.ndarray
-
property
shadowsrc
¶ Sets the source reference on Chart Studio Cloud for
shadow
.The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
size
¶ - The ‘size’ property is a number and may be specified as:
An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|float|numpy.ndarray
-
property
sizesrc
¶ Sets the source reference on Chart Studio Cloud for
size
.The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
style
¶ Sets whether a font should be styled with a normal or italic face from its family.
- The ‘style’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
stylesrc
¶ Sets the source reference on Chart Studio Cloud for
style
.The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
textcase
¶ Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- The ‘textcase’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
textcasesrc
¶ Sets the source reference on Chart Studio Cloud for
textcase
.The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
variant
¶ Sets the variant of the font.
- The ‘variant’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
Any|numpy.ndarray
-
property
variantsrc
¶ Sets the source reference on Chart Studio Cloud for
variant
.The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
- Returns
- Return type
-
property
weight
¶ Sets the weight (or boldness) of the font.
- The ‘weight’ property is a integer and may be specified as:
An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above
- Returns
- Return type
int|numpy.ndarray
-
property