plotly.graph_objects.treemap.
Domain
(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
column
¶If there is a layout grid, use the domain for this column in the grid for this treemap trace .
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
row
¶If there is a layout grid, use the domain for this row in the grid for this treemap trace .
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
x
¶fraction).
The ‘x’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
An int or float in the interval [0, 1]
An int or float in the interval [0, 1]
list
y
¶fraction).
The ‘y’ property is an info array that may be specified as:
a list or tuple of 2 elements where:
An int or float in the interval [0, 1]
An int or float in the interval [0, 1]
list
plotly.graph_objects.treemap.
Hoverlabel
(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
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
[‘left’, ‘right’, ‘auto’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
bgcolor
¶Sets the background color of the hover labels for this trace
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A list or array of any of the above
str|numpy.ndarray
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
bordercolor
¶Sets the border color of the hover labels for this trace.
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A list or array of any of the above
str|numpy.ndarray
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
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.treemap.hoverlabel.Font
A dict of string/value properties that will be passed to the Font 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
.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition
.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow
.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size
.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style
.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase
.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant
.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight
.
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.
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
int|numpy.ndarray
plotly.graph_objects.treemap.
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)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
color
¶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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A list or array of any of the above
str|numpy.ndarray
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
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”.
A non-empty string
A tuple, list, or one-dimensional numpy array of the above
str|numpy.ndarray
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
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
Any|numpy.ndarray
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
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.
A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above
str|numpy.ndarray
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
size
¶An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
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
style
¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
textcase
¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
variant
¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
weight
¶Sets the weight (or boldness) of the font.
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
int|numpy.ndarray
plotly.graph_objects.treemap.
Legendgrouptitle
(arg=None, font=None, text=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
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.treemap.legendgrouptitle.Font
A dict of string/value properties that will be passed to the Font constructor
Supported dict properties:
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”.
- 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.
- 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.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
plotly.graph_objects.treemap.
Marker
(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colors=None, colorscale=None, colorssrc=None, cornerradius=None, depthfade=None, line=None, pad=None, pattern=None, reversescale=None, showscale=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
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.
The ‘autocolorscale’ property must be specified as a bool (either True, or False)
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.
The ‘cauto’ property must be specified as a bool (either True, or False)
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.
An int or float
int|float
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
.
An int or float
int|float
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.
An int or float
int|float
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.)
colorbar
¶The ‘colorbar’ property is an instance of ColorBar that may be specified as:
An instance of
plotly.graph_objects.treemap.marker.ColorBar
A dict of string/value properties that will be passed to the ColorBar constructor
Supported dict properties:
- bgcolor
Sets the color of padded area.
- bordercolor
Sets the axis line color.
- borderwidth
Sets the width (in px) or the border enclosing this color bar.
- dtick
Sets the step in-between ticks on this axis. Use with
tick0
. Must be a positive number, or special strings available to “log” and “date” axes. If the axistype
is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, wheref
is a positive number, gives ticks linearly spaced in value (but not position). For exampletick0
= 0.1,dtick
= “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5).tick0
is ignored for “D1” and “D2”. If the axistype
is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtick
to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months.n
must be a positive integer. To set ticks on the 15th of every third month, settick0
to “2000-01-15” anddtick
to “M3”. To set ticks every 4 years, setdtick
to “M48”- exponentformat
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.
- labelalias
Replacement text for specific tick or hover labels. For example using {US: ‘USA’, CA: ‘Canada’} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.
- len
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.
- lenmode
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.- minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformat
is “SI” or “B”.- nticks
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”.- orientation
Sets the orientation of the colorbar.
- outlinecolor
Sets the axis line color.
- outlinewidth
Sets the width (in px) of the axis line.
- separatethousands
If “true”, even 4-digit integers are separated
- showexponent
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.
- showticklabels
Determines whether or not the tick labels are drawn.
- showtickprefix
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.
- showticksuffix
Same as
showtickprefix
but for tick suffixes.- thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- thicknessmode
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.- tick0
Sets the placement of the first tick on this axis. Use with
dtick
. If the axistype
is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0
to 2) except whendtick`=*L<f>* (see `dtick
for more info). If the axistype
is “date”, it should be a date string, like date data. If the axistype
is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.- tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangle
of -90 draws the tick labels vertically.- tickcolor
Sets the tick color.
- tickfont
Sets the color bar’s tick label font
- tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”
- tickformatstops
A tuple of
plotly.graph_objects.treemap .marker.colorbar.Tickformatstop
instances or dicts with compatible properties- tickformatstopdefaults
When used in a template (as layout.template.dat a.treemap.marker.colorbar.tickformatstopdefault s), sets the default property values to use for elements of treemap.marker.colorbar.tickformatstops
- ticklabeloverflow
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.
- ticklabelposition
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”.- ticklabelstep
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”.- ticklen
Sets the tick length (in px).
- tickmode
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).- tickprefix
Sets a tick label prefix.
- ticks
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.
- ticksuffix
Sets a tick label suffix.
- ticktext
Sets the text displayed at the ticks position via
tickvals
. Only has an effect iftickmode
is set to “array”. Used withtickvals
.- ticktextsrc
Sets the source reference on Chart Studio Cloud for
ticktext
.- tickvals
Sets the values at which ticks on this axis appear. Only has an effect if
tickmode
is set to “array”. Used withticktext
.- tickvalssrc
Sets the source reference on Chart Studio Cloud for
tickvals
.- tickwidth
Sets the tick width (in px).
- title
plotly.graph_objects.treemap.marker.col orbar.Title
instance or dict with compatible properties- x
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”.- xanchor
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”.- xpad
Sets the amount of padding (in px) along the x direction.
- xref
Sets the container
x
refers to. “container” spans the entirewidth
of the plot. “paper” refers to the width of the plotting area only.- y
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”.- yanchor
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”.- ypad
Sets the amount of padding (in px) along the y direction.
- yref
Sets the container
y
refers to. “container” spans the entireheight
of the plot. “paper” refers to the height of the plotting area only.
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
numpy.ndarray
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,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.
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
cornerradius
¶Sets the maximum rounding of corners (in px).
An int or float in the interval [0, inf]
int|float
depthfade
¶Determines if the sector colors are faded towards the
background from the leaves up to the headers. This option is
unavailable when a colorscale
is present, defaults to false
when marker.colors
is set, but otherwise defaults to true.
When set to “reversed”, the fading direction is inverted, that
is the top elements within hierarchy are drawn with fully
saturated colors while the leaves are faded towards the
background color.
[True, False, ‘reversed’]
Any
line
¶The ‘line’ property is an instance of Line that may be specified as:
An instance of
plotly.graph_objects.treemap.marker.Line
A dict of string/value properties that will be passed to the Line constructor
Supported dict properties:
- color
Sets the color of the line enclosing each sector. Defaults to the
paper_bgcolor
value.- colorsrc
Sets the source reference on Chart Studio Cloud for
color
.- width
Sets the width (in px) of the line enclosing each sector.
- widthsrc
Sets the source reference on Chart Studio Cloud for
width
.
pad
¶The ‘pad’ property is an instance of Pad that may be specified as:
An instance of
plotly.graph_objects.treemap.marker.Pad
A dict of string/value properties that will be passed to the Pad constructor
Supported dict properties:
- b
Sets the padding form the bottom (in px).
- l
Sets the padding form the left (in px).
- r
Sets the padding form the right (in px).
- t
Sets the padding form the top (in px).
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.treemap.marker.Pattern
A dict of string/value properties that will be passed to the Pattern constructor
Supported dict properties:
- bgcolor
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.- bgcolorsrc
Sets the source reference on Chart Studio Cloud for
bgcolor
.- fgcolor
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
.- fgcolorsrc
Sets the source reference on Chart Studio Cloud for
fgcolor
.- fgopacity
Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when
fillmode
is “overlay”. Otherwise, defaults to 1.- fillmode
Determines whether
marker.color
should be used as a default tobgcolor
or afgcolor
.- shape
Sets the shape of the pattern fill. By default, no pattern is used for filling the area.
- shapesrc
Sets the source reference on Chart Studio Cloud for
shape
.- size
Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.
- sizesrc
Sets the source reference on Chart Studio Cloud for
size
.- solidity
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.
- soliditysrc
Sets the source reference on Chart Studio Cloud for
solidity
.
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.
The ‘reversescale’ property must be specified as a bool (either True, or False)
plotly.graph_objects.treemap.
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)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
color
¶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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A list or array of any of the above
str|numpy.ndarray
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
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”.
A non-empty string
A tuple, list, or one-dimensional numpy array of the above
str|numpy.ndarray
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
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
Any|numpy.ndarray
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
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.
A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above
str|numpy.ndarray
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
size
¶An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
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
style
¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
textcase
¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
variant
¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
weight
¶Sets the weight (or boldness) of the font.
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
int|numpy.ndarray
plotly.graph_objects.treemap.
Pathbar
(arg=None, edgeshape=None, side=None, textfont=None, thickness=None, visible=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
edgeshape
¶Determines which shape is used for edges between barpath
labels.
[‘>’, ‘<’, ‘|’, ‘/’, ‘']
Any
side
¶Determines on which side of the the treemap the pathbar
should be presented.
[‘top’, ‘bottom’]
Any
textfont
¶Sets the font used inside pathbar
.
The ‘textfont’ property is an instance of Textfont that may be specified as:
An instance of
plotly.graph_objects.treemap.pathbar.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
.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition
.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow
.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size
.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style
.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase
.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant
.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight
.
thickness
¶Sets the thickness of pathbar
(in px). If not specified the
pathbar.textfont.size
is used with 3 pixles extra padding on
each side.
An int or float in the interval [12, inf]
int|float
plotly.graph_objects.treemap.
Root
(arg=None, color=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
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.
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
plotly.graph_objects.treemap.
Stream
(arg=None, maxpoints=None, token=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
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.
An int or float in the interval [0, 10000]
int|float
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.
A non-empty string
plotly.graph_objects.treemap.
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)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
color
¶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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A list or array of any of the above
str|numpy.ndarray
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
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”.
A non-empty string
A tuple, list, or one-dimensional numpy array of the above
str|numpy.ndarray
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
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
Any|numpy.ndarray
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
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.
A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above
str|numpy.ndarray
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
size
¶An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above
int|float|numpy.ndarray
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
style
¶Sets whether a font should be styled with a normal or italic face from its family.
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
textcase
¶Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
variant
¶Sets the variant of the font.
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
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
weight
¶Sets the weight (or boldness) of the font.
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
int|numpy.ndarray
plotly.graph_objects.treemap.
Tiling
(arg=None, flip=None, packing=None, pad=None, squarifyratio=None, **kwargs)¶Bases: plotly.basedatatypes.BaseTraceHierarchyType
flip
¶Determines if the positions obtained from solver are flipped on each axis.
The ‘flip’ property is a flaglist and may be specified as a string containing:
Any combination of [‘x’, ‘y’] joined with ‘+’ characters (e.g. ‘x+y’)
Any
packing
¶Determines d3 treemap solver. For more info please refer to https://github.com/d3/d3-hierarchy#treemap-tiling
[‘squarify’, ‘binary’, ‘dice’, ‘slice’, ‘slice-dice’, ‘dice-slice’]
Any
pad
¶Sets the inner padding (in px).
An int or float in the interval [0, inf]
int|float
squarifyratio
¶/ /github.com/d3/d3- hierarchy/blob/v3.1.1/README.md#squarify_ratio this option specifies the desired aspect ratio of the generated rectangles. The ratio must be specified as a number greater than or equal to one. Note that the orientation of the generated rectangles (tall or wide) is not implied by the ratio; for example, a ratio of two will attempt to produce a mixture of rectangles whose width:height ratio is either 2:1 or 1:2. When using “squarify”, unlike d3 which uses the Golden Ratio i.e. 1.618034, Plotly applies 1 to increase squares in treemap layouts.
An int or float in the interval [1, inf]
int|float
When using “squarify” packing
algorithm, according to https