plotly.graph_objects.Sunburst — 6.6.0 documentation
arg – dict of properties compatible with this constructor or an instance of
plotly.graph_objects.Sunburstbranchvalues – Determines how the items in
valuesare summed. When set to “total”, items invaluesare taken to be value of all its descendants. When set to “remainder”, items invaluescorresponding 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
valueswhen 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.Domaininstance or dict with compatible propertieshoverinfo – Determines which trace information appear on hover. If
noneorskipare set, no information is displayed upon hovering. But, ifnoneis set, click and hover events are still fired.hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.hoverlabel –
plotly.graph_objects.sunburst.Hoverlabelinstance 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. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available inhovertemplateare the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event- data. Additionally, all 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,percentEntryandpercentParent. 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>.hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.
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
hoverinfomust 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
textinfolying 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.Leafinstance 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.Legendgrouptitleinstance 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.traceorderthey 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
levelto''to start from the root node in the hierarchy. Must be an “id” ifidsis filled in, otherwise plotly attempts to find a matching item inlabels.marker –
plotly.graph_objects.sunburst.Markerinstance or dict with compatible propertiesmaxdepth – Sets the number of rendered sectors from any given
level. Setmaxdepthto “-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, annotationtextrangeselector,updatemenuesandsliderslabeltext all supportmeta. To access the tracemetavalues in an attribute in the same trace, simply use%{meta[i]}whereiis the index or key of themetaitem in question. To access tracemetain layout attributes, use%{data[n[.meta[i]}whereiis the index or key of themetaandnis 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
textinfolying 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 andinsidetextfontwould 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
idsis filled,parentsitems are understood to be “ids” themselves. Whenidsis 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.Rootinstance 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.Streaminstance or dict with compatible propertiestext – Sets text elements associated with each sector. If trace
textinfocontains a “text” flag, these elements will be seen on the chart. If tracehoverinfocontains 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 appears 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. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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,labelandvalue.texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.
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:
constraintrangeinparcoordstraces, as well as someeditable: truemodifications such asnameandcolorbar.title. Defaults tolayout.uirevision. Note that other user-driven trace attribute changes are controlled bylayoutattributes:trace.visibleis controlled bylayout.legend.uirevision,selectedpointsis 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 nouidis provided. So if your app can add/remove traces before the end of thedataarray, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace auidthat stays with it as it moves.values – Sets the values associated with each of the sectors. Use with
branchvaluesto 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).