Sunburst
Overview
The sunburst
trace type is used to create sunburst charts, which visualize hierarchical data in a circular format. Sunburst charts are useful for showing relationships between parts and the whole, with nested levels of data radiating outward from the center.
You can customize the colors, labels, and hierarchy of the chart to represent your data effectively.
Common Uses
- Hierarchical Data Visualization: Displaying relationships between different levels of data.
- Part-to-Whole Relationships: Visualizing how parts contribute to the whole across multiple levels.
- Categorical Data: Showing categorical breakdowns with nested data.
Check out the Attributes for the full set of configuration options
Examples
Common Configurations
Here's a simple sunburst
plot showing a hierarchy of categories:
You can copy this code below to create this chart in your project:
models:
- name: sunburst-data
args:
- echo
- |
labels,parents,values
Total,,100
A,Total,40
B,Total,30
C,Total,30
D,A,10
E,A,20
F,B,10
traces:
- name: Simple Sunburst Plot
model: ${ref(sunburst-data)}
props:
type: sunburst
labels: ?{labels}
parents: ?{parents}
values: ?{"values"}
charts:
- name: Simple Sunburst Chart
traces:
- ${ref(Simple Sunburst Plot)}
layout:
title:
text: Simple Sunburst Chart<br><sub>Hierarchical Data Visualization</sub>
This example demonstrates a sunburst
plot where each category has custom colors:
Here's the code:
models:
- name: sunburst-data-colors
args:
- echo
- |
labels,parents,values,colors
Total,,100,#1f77b4
A,Total,40,#ff7f0e
B,Total,30,#2ca02c
C,Total,30,#d62728
D,A,10,#9467bd
E,A,20,#8c564b
F,B,10,#e377c2
traces:
- name: Sunburst Plot with Custom Colors
model: ${ref(sunburst-data-colors)}
props:
type: sunburst
labels: ?{labels}
parents: ?{parents}
values: ?{"values"}
marker:
colors: ?{colors}
charts:
- name: Sunburst Chart with Custom Colors
traces:
- ${ref(Sunburst Plot with Custom Colors)}
layout:
title:
text: Sunburst Plot with Custom Colors<br><sub>Custom Colors for Each Category</sub>
Here's a sunburst
plot where the size of each segment is customized based on additional values:
Here's the code:
models:
- name: sunburst-data-sizes
args:
- echo
- |
labels,parents,values,size
Total,,100,1
A,Total,40,2
B,Total,30,3
C,Total,30,4
D,A,10,5
E,A,20,6
F,B,10,7
traces:
- name: Sunburst Plot with Custom Sizes
model: ${ref(sunburst-data-sizes)}
props:
type: sunburst
labels: ?{labels}
parents: ?{parents}
values: ?{"values"}
marker:
line:
width: ?{size}
color: black
charts:
- name: Sunburst Chart with Custom Sizes
traces:
- ${ref(Sunburst Plot with Custom Sizes)}
layout:
title:
text: Sunburst Plot with Custom Sizes<br><sub>Custom Sizes for Each Segment</sub>
A schema to validate plotly trace properties
Attributes
These attributes apply to traces where trace.props.type
is set to sunburst
. You would configure these attributes on the trace with the trace.props
object.
branchvalues: 'any' #(1)!
count: 'string' #(2)!
customdata: 'array' #(3)!
customdatasrc: 'string' #(4)!
domain:
column: 'integer' #(5)!
row: 'integer' #(6)!
x: 'array' #(7)!
y: 'array' #(8)!
hoverinfo: 'array' #(9)!
hoverinfosrc: 'string' #(10)!
hoverlabel:
align: 'array' #(11)!
alignsrc: 'string' #(12)!
bgcolor: 'color | array' #(13)!
bgcolorsrc: 'string' #(14)!
bordercolor: 'color | array' #(15)!
bordercolorsrc: 'string' #(16)!
font:
color: color | array
colorsrc: 'string' #(17)!
family: 'string | array' #(18)!
familysrc: 'string' #(19)!
lineposition: 'array' #(20)!
linepositionsrc: 'string' #(21)!
shadow: 'string | array' #(22)!
shadowsrc: 'string' #(23)!
size: number | array
sizesrc: 'string' #(24)!
style: 'array' #(25)!
stylesrc: 'string' #(26)!
textcase: 'array' #(27)!
textcasesrc: 'string' #(28)!
variant: 'array' #(29)!
variantsrc: 'string' #(30)!
weight: 'integer | array' #(31)!
weightsrc: 'string' #(32)!
namelength: 'integer | array' #(33)!
namelengthsrc: 'string' #(34)!
hovertemplate: 'string | array' #(35)!
hovertemplatesrc: 'string' #(36)!
hovertext: 'string | array' #(37)!
hovertextsrc: 'string' #(38)!
ids: 'array' #(39)!
idssrc: 'string' #(40)!
insidetextfont:
color: color | array
colorsrc: 'string' #(41)!
family: 'string | array' #(42)!
familysrc: 'string' #(43)!
lineposition: 'array' #(44)!
linepositionsrc: 'string' #(45)!
shadow: 'string | array' #(46)!
shadowsrc: 'string' #(47)!
size: number | array
sizesrc: 'string' #(48)!
style: 'array' #(49)!
stylesrc: 'string' #(50)!
textcase: 'array' #(51)!
textcasesrc: 'string' #(52)!
variant: 'array' #(53)!
variantsrc: 'string' #(54)!
weight: 'integer | array' #(55)!
weightsrc: 'string' #(56)!
insidetextorientation: 'any' #(57)!
labels: 'array' #(58)!
labelssrc: 'string' #(59)!
leaf:
opacity: 'number' #(60)!
legend: 'string' #(61)!
legendgrouptitle:
font:
color: any
family: 'string' #(62)!
lineposition: 'string' #(63)!
shadow: 'string' #(64)!
size: number
style: 'any' #(65)!
textcase: 'any' #(66)!
variant: 'any' #(67)!
weight: 'integer' #(68)!
text: 'string' #(69)!
legendrank: 'number' #(70)!
legendwidth: 'number' #(71)!
marker:
autocolorscale: 'boolean' #(72)!
cauto: 'boolean' #(73)!
cmax: 'number' #(74)!
cmid: 'number' #(75)!
cmin: 'number' #(76)!
coloraxis: 'string' #(77)!
colorbar:
bgcolor: 'any' #(78)!
bordercolor: 'any' #(79)!
borderwidth: 'number' #(80)!
exponentformat: 'any' #(81)!
len: 'number' #(82)!
lenmode: 'any' #(83)!
minexponent: 'number' #(84)!
nticks: 'integer' #(85)!
orientation: 'any' #(86)!
outlinecolor: 'any' #(87)!
outlinewidth: 'number' #(88)!
separatethousands: 'boolean' #(89)!
showexponent: 'any' #(90)!
showticklabels: 'boolean' #(91)!
showtickprefix: 'any' #(92)!
showticksuffix: 'any' #(93)!
thickness: 'number' #(94)!
thicknessmode: 'any' #(95)!
tickangle: 'number' #(96)!
tickcolor: 'any' #(97)!
tickfont:
color: any
family: 'string' #(98)!
lineposition: 'string' #(99)!
shadow: 'string' #(100)!
size: number
style: 'any' #(101)!
textcase: 'any' #(102)!
variant: 'any' #(103)!
weight: 'integer' #(104)!
tickformat: 'string' #(105)!
tickformatstops: array
ticklabeloverflow: 'any' #(106)!
ticklabelposition: 'any' #(107)!
ticklabelstep: 'integer' #(108)!
ticklen: 'number' #(109)!
tickmode: 'any' #(110)!
tickprefix: 'string' #(111)!
ticks: 'any' #(112)!
ticksuffix: 'string' #(113)!
ticktext: 'array' #(114)!
ticktextsrc: 'string' #(115)!
tickvals: 'array' #(116)!
tickvalssrc: 'string' #(117)!
tickwidth: 'number' #(118)!
title:
font:
color: any
family: 'string' #(119)!
lineposition: 'string' #(120)!
shadow: 'string' #(121)!
size: number
style: 'any' #(122)!
textcase: 'any' #(123)!
variant: 'any' #(124)!
weight: 'integer' #(125)!
side: 'any' #(126)!
text: 'string' #(127)!
x: 'number' #(128)!
xanchor: 'any' #(129)!
xpad: 'number' #(130)!
xref: 'any' #(131)!
y: 'number' #(132)!
yanchor: 'any' #(133)!
ypad: 'number' #(134)!
yref: 'any' #(135)!
colors: 'array' #(136)!
colorscale: 'any' #(137)!
colorssrc: 'string' #(138)!
line:
color: 'color | array' #(139)!
colorsrc: 'string' #(140)!
width: 'number | array' #(141)!
widthsrc: 'string' #(142)!
pattern:
bgcolor: 'color | array' #(143)!
bgcolorsrc: 'string' #(144)!
fgcolor: 'color | array' #(145)!
fgcolorsrc: 'string' #(146)!
fgopacity: 'number' #(147)!
fillmode: 'any' #(148)!
shape: 'array' #(149)!
shapesrc: 'string' #(150)!
size: 'number | array' #(151)!
sizesrc: 'string' #(152)!
solidity: 'number | array' #(153)!
soliditysrc: 'string' #(154)!
reversescale: 'boolean' #(155)!
showscale: 'boolean' #(156)!
maxdepth: 'integer' #(157)!
metasrc: 'string' #(158)!
name: 'string' #(159)!
opacity: 'number' #(160)!
outsidetextfont:
color: color | array
colorsrc: 'string' #(161)!
family: 'string | array' #(162)!
familysrc: 'string' #(163)!
lineposition: 'array' #(164)!
linepositionsrc: 'string' #(165)!
shadow: 'string | array' #(166)!
shadowsrc: 'string' #(167)!
size: number | array
sizesrc: 'string' #(168)!
style: 'array' #(169)!
stylesrc: 'string' #(170)!
textcase: 'array' #(171)!
textcasesrc: 'string' #(172)!
variant: 'array' #(173)!
variantsrc: 'string' #(174)!
weight: 'integer | array' #(175)!
weightsrc: 'string' #(176)!
parents: 'array' #(177)!
parentssrc: 'string' #(178)!
root:
color: 'any' #(179)!
rotation: 'number' #(180)!
sort: 'boolean' #(181)!
stream:
maxpoints: 'number' #(182)!
token: 'string' #(183)!
text: 'array' #(184)!
textfont:
color: color | array
colorsrc: 'string' #(185)!
family: 'string | array' #(186)!
familysrc: 'string' #(187)!
lineposition: 'array' #(188)!
linepositionsrc: 'string' #(189)!
shadow: 'string | array' #(190)!
shadowsrc: 'string' #(191)!
size: number | array
sizesrc: 'string' #(192)!
style: 'array' #(193)!
stylesrc: 'string' #(194)!
textcase: 'array' #(195)!
textcasesrc: 'string' #(196)!
variant: 'array' #(197)!
variantsrc: 'string' #(198)!
weight: 'integer | array' #(199)!
weightsrc: 'string' #(200)!
textinfo: 'string' #(201)!
textsrc: 'string' #(202)!
texttemplate: 'string | array' #(203)!
texttemplatesrc: 'string' #(204)!
type: sunburst
uid: 'string' #(205)!
values: 'array' #(206)!
valuessrc: 'string' #(207)!
visible: 'any' #(208)!
- 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. - Determines default for
values
when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0. - 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
- Sets the source reference on Chart Studio Cloud for
customdata
. - If there is a layout grid, use the domain for this column in the grid for this sunburst trace .
- If there is a layout grid, use the domain for this row in the grid for this sunburst trace .
- Sets the horizontal domain of this sunburst trace (in plot fraction).
- Sets the vertical domain of this sunburst trace (in plot fraction).
- 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. - Sets the source reference on Chart Studio Cloud for
hoverinfo
. - 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
- Sets the source reference on Chart Studio Cloud for
align
. - Sets the background color of the hover labels for this trace
- Sets the source reference on Chart Studio Cloud for
bgcolor
. - Sets the border color of the hover labels for this trace.
- Sets the source reference on Chart Studio Cloud for
bordercolor
. - Sets the source reference on Chart Studio Cloud for
color
. - 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.
- Sets the source reference on Chart Studio Cloud for
family
. - 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.
- Sets the source reference on Chart Studio Cloud for
lineposition
. - 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.
- Sets the source reference on Chart Studio Cloud for
shadow
. - Sets the source reference on Chart Studio Cloud for
size
. - Sets whether a font should be styled with a normal or italic face from its family.
- Sets the source reference on Chart Studio Cloud for
style
. - Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- Sets the source reference on Chart Studio Cloud for
textcase
. - Sets the variant of the font.
- Sets the source reference on Chart Studio Cloud for
variant
. - Sets the weight (or boldness) of the font.
- Sets the source reference on Chart Studio Cloud for
weight
. - 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. - Sets the source reference on Chart Studio Cloud for
namelength
. - 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 "{fullData.name} ". To hide the secondary box completely, use an empty tag<extra></extra>
. - Sets the source reference on Chart Studio Cloud for
hovertemplate
. - 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. - Sets the source reference on Chart Studio Cloud for
hovertext
. - 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.
- Sets the source reference on Chart Studio Cloud for
ids
. - Sets the source reference on Chart Studio Cloud for
color
. - 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.
- Sets the source reference on Chart Studio Cloud for
family
. - 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.
- Sets the source reference on Chart Studio Cloud for
lineposition
. - 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.
- Sets the source reference on Chart Studio Cloud for
shadow
. - Sets the source reference on Chart Studio Cloud for
size
. - Sets whether a font should be styled with a normal or italic face from its family.
- Sets the source reference on Chart Studio Cloud for
style
. - Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- Sets the source reference on Chart Studio Cloud for
textcase
. - Sets the variant of the font.
- Sets the source reference on Chart Studio Cloud for
variant
. - Sets the weight (or boldness) of the font.
- Sets the source reference on Chart Studio Cloud for
weight
. - 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.
- Sets the labels of each of the sectors.
- Sets the source reference on Chart Studio Cloud for
labels
. - Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7
- 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. - 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.
- 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.
- 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.
- Sets whether a font should be styled with a normal or italic face from its family.
- Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- Sets the variant of the font.
- Sets the weight (or boldness) of the font.
- Sets the title of the legend group.
- 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. - Sets the width (in px or fraction) of the legend for this trace.
- 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. - 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. - 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. - 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
. - 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. - 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. - Sets the color of padded area.
- Sets the axis line color.
- Sets the width (in px) or the border enclosing this color bar.
- Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If none, it appears as 1,000,000,000. If e, 1e+9. If E, 1E+9. If power, 1x10^9 (with 9 in a super script). If SI, 1G. If B, 1B.
- Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
- Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use
len
to set the value. - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformat
is SI or B. - Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to
nticks
. Has an effect only iftickmode
is set to auto. - Sets the orientation of the colorbar.
- Sets the axis line color.
- Sets the width (in px) of the axis line.
- If "true", even 4-digit integers are separated
- If all, all exponents are shown besides their significands. If first, only the exponent of the first tick is shown. If last, only the exponent of the last tick is shown. If none, no exponents appear.
- Determines whether or not the tick labels are drawn.
- If all, all tick labels are displayed with a prefix. If first, only the first tick is displayed with a prefix. If last, only the last tick is displayed with a suffix. If none, tick prefixes are hidden.
- Same as
showtickprefix
but for tick suffixes. - Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use
thickness
to set the value. - Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangle
of -90 draws the tick labels vertically. - Sets the tick color.
- 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.
- 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.
- 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.
- Sets whether a font should be styled with a normal or italic face from its family.
- Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- Sets the variant of the font.
- Sets the weight (or boldness) of the font.
- Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: %h for half of the year as a decimal number as well as %{n}f for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat %H~%M~%S.%2f would display 09~15~23.46
- Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.
- Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientation
is h, top and bottom whenorientation
is v. - Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled.
tick0
determines which labels are shown. Not implemented for axes withtype
log or multicategory, or whentickmode
is array. - Sets the tick length (in px).
- Sets the tick mode for this axis. If auto, the number of ticks is set via
nticks
. If linear, the placement of the ticks is determined by a starting positiontick0
and a tick stepdtick
(linear is the default value iftick0
anddtick
are provided). If array, the placement of the ticks is set viatickvals
and the tick text isticktext
. (array is the default value iftickvals
is provided). - Sets a tick label prefix.
- Determines whether ticks are drawn or not. If , this axis' ticks are not drawn. If outside (inside), this axis' are drawn outside (inside) the axis lines.
- Sets a tick label suffix.
- Sets the text displayed at the ticks position via
tickvals
. Only has an effect iftickmode
is set to array. Used withtickvals
. - Sets the source reference on Chart Studio Cloud for
ticktext
. - Sets the values at which ticks on this axis appear. Only has an effect if
tickmode
is set to array. Used withticktext
. - Sets the source reference on Chart Studio Cloud for
tickvals
. - Sets the tick width (in px).
- 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.
- 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.
- 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.
- Sets whether a font should be styled with a normal or italic face from its family.
- Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- Sets the variant of the font.
- Sets the weight (or boldness) of the font.
- Determines the location of color bar's title with respect to the color bar. Defaults to top when
orientation
if v and defaults to right whenorientation
if h. - Sets the title of the color bar.
- Sets the x position with respect to
xref
of the color bar (in plot fraction). Whenxref
is paper, defaults to 1.02 whenorientation
is v and 0.5 whenorientation
is h. Whenxref
is container, defaults to 1 whenorientation
is v and 0.5 whenorientation
is h. Must be between 0 and 1 ifxref
is container and between -2 and 3 ifxref
is paper. - Sets this color bar's horizontal position anchor. This anchor binds the
x
position to the left, center or right of the color bar. Defaults to left whenorientation
is v and center whenorientation
is h. - Sets the amount of padding (in px) along the x direction.
- Sets the container
x
refers to. container spans the entirewidth
of the plot. paper refers to the width of the plotting area only. - Sets the y position with respect to
yref
of the color bar (in plot fraction). Whenyref
is paper, defaults to 0.5 whenorientation
is v and 1.02 whenorientation
is h. Whenyref
is container, defaults to 0.5 whenorientation
is v and 1 whenorientation
is h. Must be between 0 and 1 ifyref
is container and between -2 and 3 ifyref
is paper. - Sets this color bar's vertical position anchor This anchor binds the
y
position to the top, middle or bottom of the color bar. Defaults to middle whenorientation
is v and bottom whenorientation
is h. - Sets the amount of padding (in px) along the y direction.
- Sets the container
y
refers to. container spans the entireheight
of the plot. paper refers to the height of the plotting area only. - Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.
- 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,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. - Sets the source reference on Chart Studio Cloud for
colors
. - Sets the color of the line enclosing each sector. Defaults to the
paper_bgcolor
value. - Sets the source reference on Chart Studio Cloud for
color
. - Sets the width (in px) of the line enclosing each sector.
- Sets the source reference on Chart Studio Cloud for
width
. - When there is no colorscale sets the color of background pattern fill. Defaults to a
marker.color
background whenfillmode
is overlay. Otherwise, defaults to a transparent background. - Sets the source reference on Chart Studio Cloud for
bgcolor
. - When there is no colorscale sets the color of foreground pattern fill. Defaults to a
marker.color
background whenfillmode
is replace. Otherwise, defaults to dark grey or white to increase contrast with thebgcolor
. - Sets the source reference on Chart Studio Cloud for
fgcolor
. - Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when
fillmode
is overlay. Otherwise, defaults to 1. - Determines whether
marker.color
should be used as a default tobgcolor
or afgcolor
. - Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
- Sets the source reference on Chart Studio Cloud for
shape
. - Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
- Sets the source reference on Chart Studio Cloud for
size
. - Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.
- Sets the source reference on Chart Studio Cloud for
solidity
. - 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. - Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.
- Sets the number of rendered sectors from any given
level
. Setmaxdepth
to -1 to render all the levels in the hierarchy. - Sets the source reference on Chart Studio Cloud for
meta
. - Sets the trace name. The trace name appears as the legend item and on hover.
- Sets the opacity of the trace.
- Sets the source reference on Chart Studio Cloud for
color
. - 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.
- Sets the source reference on Chart Studio Cloud for
family
. - 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.
- Sets the source reference on Chart Studio Cloud for
lineposition
. - 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.
- Sets the source reference on Chart Studio Cloud for
shadow
. - Sets the source reference on Chart Studio Cloud for
size
. - Sets whether a font should be styled with a normal or italic face from its family.
- Sets the source reference on Chart Studio Cloud for
style
. - Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- Sets the source reference on Chart Studio Cloud for
textcase
. - Sets the variant of the font.
- Sets the source reference on Chart Studio Cloud for
variant
. - Sets the weight (or boldness) of the font.
- Sets the source reference on Chart Studio Cloud for
weight
. - 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. - Sets the source reference on Chart Studio Cloud for
parents
. - 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.
- Rotates the whole diagram counterclockwise by some angle. By default the first slice starts at 3 o'clock.
- Determines whether or not the sectors are reordered from largest to smallest.
- 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 stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.
- 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. - Sets the source reference on Chart Studio Cloud for
color
. - 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.
- Sets the source reference on Chart Studio Cloud for
family
. - 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.
- Sets the source reference on Chart Studio Cloud for
lineposition
. - 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.
- Sets the source reference on Chart Studio Cloud for
shadow
. - Sets the source reference on Chart Studio Cloud for
size
. - Sets whether a font should be styled with a normal or italic face from its family.
- Sets the source reference on Chart Studio Cloud for
style
. - Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
- Sets the source reference on Chart Studio Cloud for
textcase
. - Sets the variant of the font.
- Sets the source reference on Chart Studio Cloud for
variant
. - Sets the weight (or boldness) of the font.
- Sets the source reference on Chart Studio Cloud for
weight
. - Determines which trace information appear on the graph.
- Sets the source reference on Chart Studio Cloud for
text
. - 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
. - Sets the source reference on Chart Studio Cloud for
texttemplate
. - Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
- Sets the values associated with each of the sectors. Use with
branchvalues
to determine how the values are summed. - Sets the source reference on Chart Studio Cloud for
values
. - 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).