`plotly.graph_objects`.Icicle¶

class plotly.graph_objects.Icicle(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶

__init__(arg=None, branchvalues=None, count=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, insidetextfont=None, labels=None, labelssrc=None, leaf=None, legend=None, legendgrouptitle=None, legendrank=None, legendwidth=None, level=None, marker=None, maxdepth=None, meta=None, metasrc=None, name=None, opacity=None, outsidetextfont=None, parents=None, parentssrc=None, pathbar=None, root=None, sort=None, stream=None, text=None, textfont=None, textinfo=None, textposition=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tiling=None, uid=None, uirevision=None, values=None, valuessrc=None, visible=None, **kwargs)¶

Construct a new Icicle object

Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The icicle sectors are determined by the entries in “labels” or “ids” and in “parents”.

Parameters

arg – dict of properties compatible with this constructor or an instance of plotly.graph_objects.Icicle
branchvalues – Determines how the items in values are summed. When set to “total”, items in values are taken to be value of all its descendants. When set to “remainder”, items in values corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.
count – Determines default for values when it is not provided, by inferring a 1 for each of the “leaves” and/or “branches”, otherwise 0.
customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements
customdatasrc – Sets the source reference on Chart Studio Cloud for customdata.
domain – plotly.graph_objects.icicle.Domain instance or dict with compatible properties
hoverinfo – Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.
hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo.
hoverlabel – plotly.graph_objects.icicle.Hoverlabel instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event- data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry and percentParent. Anything contained in tag <extra> is displayed in the secondary box, for example “<extra>{fullData.name}</extra>”. To hide the secondary box completely, use an empty tag <extra></extra>.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate.
hovertext – Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a “text” flag.
hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for ids.
insidetextfont – Sets the font used for textinfo lying inside the sector.
labels – Sets the labels of each of the sectors.
labelssrc – Sets the source reference on Chart Studio Cloud for labels.
leaf – plotly.graph_objects.icicle.Leaf instance or dict with compatible properties
legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under layout.legend, layout.legend2, etc.
legendgrouptitle – plotly.graph_objects.icicle.Legendgrouptitle instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed” legend.traceorder they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.
legendwidth – Sets the width (in px or fraction) of the legend for this trace.
level – Sets the level from which this trace hierarchy is rendered. Set level to '' to start from the root node in the hierarchy. Must be an “id” if ids is filled in, otherwise plotly attempts to find a matching item in labels.
marker – plotly.graph_objects.icicle.Marker instance or dict with compatible properties
maxdepth – Sets the number of rendered sectors from any given level. Set maxdepth to “-1” to render all the levels in the hierarchy.
meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.
metasrc – Sets the source reference on Chart Studio Cloud for meta.
name – Sets the trace name. The trace name appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
outsidetextfont – Sets the font used for textinfo lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won’t have any effect and insidetextfont would be used.
parents – Sets the parent sectors for each of the sectors. Empty string items ‘’ are understood to reference the root node in the hierarchy. If ids is filled, parents items are understood to be “ids” themselves. When ids is not set, plotly attempts to find matching items in labels, but beware they must be unique.
parentssrc – Sets the source reference on Chart Studio Cloud for parents.
pathbar – plotly.graph_objects.icicle.Pathbar instance or dict with compatible properties
root – plotly.graph_objects.icicle.Root instance or dict with compatible properties
sort – Determines whether or not the sectors are reordered from largest to smallest.
stream – plotly.graph_objects.icicle.Stream instance or dict with compatible properties
text – Sets text elements associated with each sector. If trace textinfo contains a “text” flag, these elements will be seen on the chart. If trace hoverinfo contains a “text” flag and “hovertext” is not set, these elements will be seen in the hover labels.
textfont – Sets the font used for textinfo.
textinfo – Determines which trace information appear on the graph.
textposition – Sets the positions of the text elements.
textsrc – Sets the source reference on Chart Studio Cloud for text.
texttemplate – Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. Finally, the template string has access to variables currentPath, root, entry, percentRoot, percentEntry, percentParent, label and value.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate.
tiling – plotly.graph_objects.icicle.Tiling instance or dict with compatible properties
uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.
values – Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.
valuessrc – Sets the source reference on Chart Studio Cloud for values.
visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Returns

Return type

Icicle

`plotly.graph_objects`.icicle¶

plotly.graph_objects.icicle

class plotly.graph_objects.icicle.Domain(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶

property column¶

If there is a layout grid, use the domain for this column in the grid for this icicle trace .

The ‘column’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property row¶

If there is a layout grid, use the domain for this row in the grid for this icicle trace .

The ‘row’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property x¶

Sets the horizontal domain of this icicle trace (in plot

fraction).

The ‘x’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘x[0]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
The ‘x[1]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
list

property y¶

Sets the vertical domain of this icicle trace (in plot

fraction).

The ‘y’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘y[0]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
The ‘y[1]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
list

class plotly.graph_objects.icicle.Hoverlabel(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, **kwargs)¶

property align¶

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

The ‘align’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘left’, ‘right’, ‘auto’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property alignsrc¶

Sets the source reference on Chart Studio Cloud for align.

The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property bgcolor¶

Sets the background color of the hover labels for this trace

The ‘bgcolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
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

Returns
Return type: str|numpy.ndarray

property bgcolorsrc¶

Sets the source reference on Chart Studio Cloud for bgcolor.

The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property bordercolor¶

Sets the border color of the hover labels for this trace.

The ‘bordercolor’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
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

Returns
Return type: str|numpy.ndarray

property bordercolorsrc¶

Sets the source reference on Chart Studio Cloud for bordercolor.

The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property font¶

Sets the font used in hover labels.

The ‘font’ property is an instance of Font that may be specified as:

An instance of plotly.graph_objects.icicle.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.

Returns
Return type: plotly.graph_objects.icicle.hoverlabel.Font

property namelength¶

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to namelength - 3 characters and add an ellipsis.

The ‘namelength’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|numpy.ndarray

property namelengthsrc¶

Sets the source reference on Chart Studio Cloud for namelength.

The ‘namelengthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class plotly.graph_objects.icicle.Insidetextfont(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)¶

property color¶

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
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

Returns
Return type: str|numpy.ndarray

property colorsrc¶

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property 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”.

The ‘family’ property is a string and must be specified as:

A non-empty string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property familysrc¶

Sets the source reference on Chart Studio Cloud for family.

The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property lineposition¶

Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

A list or array of the above

Returns
Return type: Any|numpy.ndarray

property linepositionsrc¶

Sets the source reference on Chart Studio Cloud for lineposition.

The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property shadow¶

Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

The ‘shadow’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property shadowsrc¶

Sets the source reference on Chart Studio Cloud for shadow.

The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property size¶

The ‘size’ property is a number and may be specified as:

An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property sizesrc¶

Sets the source reference on Chart Studio Cloud for size.

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property style¶

Sets whether a font should be styled with a normal or italic face from its family.

The ‘style’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property stylesrc¶

Sets the source reference on Chart Studio Cloud for style.

The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property textcase¶

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

The ‘textcase’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property textcasesrc¶

Sets the source reference on Chart Studio Cloud for textcase.

The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property variant¶

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property variantsrc¶

Sets the source reference on Chart Studio Cloud for variant.

The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|numpy.ndarray

property weightsrc¶

Sets the source reference on Chart Studio Cloud for weight.

The ‘weightsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class plotly.graph_objects.icicle.Leaf(arg=None, opacity=None, **kwargs)¶

property opacity¶

Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7

The ‘opacity’ property is a number and may be specified as:

An int or float in the interval [0, 1]

Returns
Return type: int|float

class plotly.graph_objects.icicle.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶

property font¶

Sets this legend group’s title font.

The ‘font’ property is an instance of Font that may be specified as:

An instance of plotly.graph_objects.icicle.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.

Returns
Return type: plotly.graph_objects.icicle.legendgrouptitle.Font

property text¶

Sets the title of the legend group.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

class plotly.graph_objects.icicle.Marker(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colors=None, colorscale=None, colorssrc=None, line=None, pattern=None, reversescale=None, showscale=None, **kwargs)¶

property autocolorscale¶

Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined 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)

Returns
Return type: bool

property cauto¶

Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in marker.cmin 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)

Returns
Return type: bool

property cmax¶

Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, marker.cmin must be set as well.

The ‘cmax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property cmid¶

Sets the mid-point of the color domain by scaling marker.cmin and/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.

The ‘cmid’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property cmin¶

Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, marker.cmax must be set as well.

The ‘cmin’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property coloraxis¶

Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.icicle.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 axis type 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>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 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 axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick 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, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick 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 if tickmode 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 axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type 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.icicle. marker.colorbar.Tickformatstop instances or dicts with compatible properties

tickformatstopdefaults
When used in a template (as layout.template.dat a.icicle.marker.colorbar.tickformatstopdefaults ), sets the default property values to use for elements of icicle.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 when orientation 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 with type “log” or “multicategory”, or when tickmode 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 position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals 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 if tickmode is set to “array”. Used with tickvals.

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 with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.icicle.marker.colo rbar.Title instance or dict with compatible properties

titlefont
Deprecated: Please use icicle.marker.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

titleside
Deprecated: Please use icicle.marker.colorbar.title.side instead. 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” when orientation if “h”. Note that the title’s location used to be set by the now deprecated titleside attribute.

x
Sets the x position with respect to xref of the color bar (in plot fraction). When xref is “paper”, defaults to 1.02 when orientation is “v” and 0.5 when orientation is “h”. When xref is “container”, defaults to 1 when orientation is “v” and 0.5 when orientation is “h”. Must be between 0 and 1 if xref is “container” and between “-2” and 3 if xref 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” when orientation is “v” and “center” when orientation is “h”.

xpad
Sets the amount of padding (in px) along the x direction.

xref
Sets the container x refers to. “container” spans the entire width 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). When yref is “paper”, defaults to 0.5 when orientation is “v” and 1.02 when orientation is “h”. When yref is “container”, defaults to 0.5 when orientation is “v” and 1 when orientation is “h”. Must be between 0 and 1 if yref is “container” and between “-2” and 3 if yref 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” when orientation is “v” and “bottom” when orientation is “h”.

ypad
Sets the amount of padding (in px) along the y direction.

yref
Sets the container y refers to. “container” spans the entire height of the plot. “paper” refers to the height of the plotting area only.

Returns
Return type: plotly.graph_objects.icicle.marker.ColorBar

property colors¶

Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.

The ‘colors’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property colorscale¶

Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in color space, 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.

Returns
Return type: str

property colorssrc¶

Sets the source reference on Chart Studio Cloud for colors.

The ‘colorssrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property line¶

The ‘line’ property is an instance of Line that may be specified as:

An instance of plotly.graph_objects.icicle.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.

Returns
Return type: plotly.graph_objects.icicle.marker.Line

property pattern¶

Sets the pattern within the marker.

The ‘pattern’ property is an instance of Pattern that may be specified as:

An instance of plotly.graph_objects.icicle.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 when fillmode 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 when fillmode is “replace”. Otherwise, defaults to dark grey or white to increase contrast with the bgcolor.

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 to bgcolor or a fgcolor.

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.

Returns
Return type: plotly.graph_objects.icicle.marker.Pattern

property reversescale¶

Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.

The ‘reversescale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property showscale¶

Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.

The ‘showscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

class plotly.graph_objects.icicle.Outsidetextfont(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)¶

property color¶

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
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

Returns
Return type: str|numpy.ndarray

property colorsrc¶

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property family¶

The ‘family’ property is a string and must be specified as:

A non-empty string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property familysrc¶

Sets the source reference on Chart Studio Cloud for family.

The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property lineposition¶

Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

A list or array of the above

Returns
Return type: Any|numpy.ndarray

property linepositionsrc¶

Sets the source reference on Chart Studio Cloud for lineposition.

The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property shadow¶

The ‘shadow’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property shadowsrc¶

Sets the source reference on Chart Studio Cloud for shadow.

The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property size¶

The ‘size’ property is a number and may be specified as:

An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property sizesrc¶

Sets the source reference on Chart Studio Cloud for size.

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property style¶

Sets whether a font should be styled with a normal or italic face from its family.

The ‘style’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property stylesrc¶

Sets the source reference on Chart Studio Cloud for style.

The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property textcase¶

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

The ‘textcase’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property textcasesrc¶

Sets the source reference on Chart Studio Cloud for textcase.

The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property variant¶

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property variantsrc¶

Sets the source reference on Chart Studio Cloud for variant.

The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|numpy.ndarray

property weightsrc¶

Sets the source reference on Chart Studio Cloud for weight.

The ‘weightsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class plotly.graph_objects.icicle.Pathbar(arg=None, edgeshape=None, side=None, textfont=None, thickness=None, visible=None, **kwargs)¶

property edgeshape¶

Determines which shape is used for edges between barpath labels.

The ‘edgeshape’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘>’, ‘<’, ‘|’, ‘/’, ‘']

Returns
Return type: Any

property side¶

Determines on which side of the the treemap the pathbar should be presented.

The ‘side’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘top’, ‘bottom’]

Returns
Return type: Any

property 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.icicle.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.

Returns
Return type: plotly.graph_objects.icicle.pathbar.Textfont

property 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.

The ‘thickness’ property is a number and may be specified as:

An int or float in the interval [12, inf]

Returns
Return type: int|float

property visible¶

Determines if the path bar is drawn i.e. outside the trace domain and with one pixel gap.

The ‘visible’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

class plotly.graph_objects.icicle.Root(arg=None, color=None, **kwargs)¶

property color¶

sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
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

Returns
Return type: str

class plotly.graph_objects.icicle.Stream(arg=None, maxpoints=None, token=None, **kwargs)¶

property maxpoints¶

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

The ‘maxpoints’ property is a number and may be specified as:

An int or float in the interval [0, 10000]

Returns
Return type: int|float

property token¶

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

The ‘token’ property is a string and must be specified as:

A non-empty string

Returns
Return type: str

class plotly.graph_objects.icicle.Textfont(arg=None, color=None, colorsrc=None, family=None, familysrc=None, lineposition=None, linepositionsrc=None, shadow=None, shadowsrc=None, size=None, sizesrc=None, style=None, stylesrc=None, textcase=None, textcasesrc=None, variant=None, variantsrc=None, weight=None, weightsrc=None, **kwargs)¶

property color¶

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
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

Returns
Return type: str|numpy.ndarray

property colorsrc¶

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property family¶

The ‘family’ property is a string and must be specified as:

A non-empty string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property familysrc¶

Sets the source reference on Chart Studio Cloud for family.

The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property lineposition¶

Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

A list or array of the above

Returns
Return type: Any|numpy.ndarray

property linepositionsrc¶

Sets the source reference on Chart Studio Cloud for lineposition.

The ‘linepositionsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property shadow¶

The ‘shadow’ property is a string and must be specified as:

A string
A number that will be converted to a string
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: str|numpy.ndarray

property shadowsrc¶

Sets the source reference on Chart Studio Cloud for shadow.

The ‘shadowsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property size¶

The ‘size’ property is a number and may be specified as:

An int or float in the interval [1, inf]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|float|numpy.ndarray

property sizesrc¶

Sets the source reference on Chart Studio Cloud for size.

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property style¶

Sets whether a font should be styled with a normal or italic face from its family.

The ‘style’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘italic’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property stylesrc¶

Sets the source reference on Chart Studio Cloud for style.

The ‘stylesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property textcase¶

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

The ‘textcase’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property textcasesrc¶

Sets the source reference on Chart Studio Cloud for textcase.

The ‘textcasesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property variant¶

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: Any|numpy.ndarray

property variantsrc¶

Sets the source reference on Chart Studio Cloud for variant.

The ‘variantsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)
A tuple, list, or one-dimensional numpy array of the above

Returns
Return type: int|numpy.ndarray

property weightsrc¶

Sets the source reference on Chart Studio Cloud for weight.

The ‘weightsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

class plotly.graph_objects.icicle.Tiling(arg=None, flip=None, orientation=None, pad=None, **kwargs)¶

property 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’)

Returns
Return type: Any

property orientation¶

When set in conjunction with tiling.flip, determines on which side the root nodes are drawn in the chart. If tiling.orientation is “v” and tiling.flip is “”, the root nodes appear at the top. If tiling.orientation is “v” and tiling.flip is “y”, the root nodes appear at the bottom. If tiling.orientation is “h” and tiling.flip is “”, the root nodes appear at the left. If tiling.orientation is “h” and tiling.flip is “x”, the root nodes appear at the right.

The ‘orientation’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘v’, ‘h’]

Returns
Return type: Any

property pad¶

Sets the inner padding (in px).

The ‘pad’ property is a number and may be specified as:

An int or float in the interval [0, inf]

Returns
Return type: int|float

plotly.graph_objects.Icicle¶

plotly.graph_objects.icicle¶

`plotly.graph_objects`.Icicle¶

`plotly.graph_objects`.icicle¶