API Reference
< Back to docs

plotly.graph_objs.treemap Module

Globals

Functions

plotly.graph_objs.treemap.Domain([column=], [row=], [x=], [y=]) → Domain

Create a new ‘Domain’ object

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

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

  • x - Sets the horizontal domain of this treemap trace (in plot fraction).

  • y - Sets the vertical domain of this treemap trace (in plot fraction).

plotly.graph_objs.treemap.Hoverlabel([align=], [alignsrc=], [bgcolor=], [bgcolorsrc=], [bordercolor=], [bordercolorsrc=], [font=], [namelength=], [namelengthsrc=]) → Hoverlabel

Create a new ‘Hoverlabel’ object

  • 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

  • alignsrc - Sets the source reference on Chart Studio Cloud for `align`.

  • bgcolor - Sets the background color of the hover labels for this trace

  • bgcolorsrc - Sets the source reference on Chart Studio Cloud for `bgcolor`.

  • bordercolor - Sets the border color of the hover labels for this trace.

  • bordercolorsrc - Sets the source reference on Chart Studio Cloud for `bordercolor`.

  • font - Sets the font used in hover labels.

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

  • namelengthsrc - Sets the source reference on Chart Studio Cloud for `namelength`.

plotly.graph_objs.treemap.Insidetextfont([color=], [colorsrc=], [family=], [familysrc=], [size=], [sizesrc=]) → Insidetextfont

Create a new ‘Insidetextfont’ object

  • 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`.

  • sizesrc - Sets the source reference on Chart Studio Cloud for `size`.

plotly.graph_objs.treemap.Legendgrouptitle([font=], [text=]) → Legendgrouptitle

Create a new ‘Legendgrouptitle’ object

  • font - Sets this legend group's title font.

  • text - Sets the title of the legend group.

plotly.graph_objs.treemap.Marker([autocolorscale=], [cauto=], [cmax=], [cmid=], [cmin=], [coloraxis=], [colorbar=], [colors=], [colorscale=], [colorssrc=], [cornerradius=], [depthfade=], [line=], [pad=], [reversescale=], [showscale=]) → Marker

Create a new ‘Marker’ object

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

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

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

  • 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`.

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

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

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

  • 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,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

  • colorssrc - Sets the source reference on Chart Studio Cloud for `colors`.

  • cornerradius - Sets the maximum rounding of corners (in px).

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

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

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

plotly.graph_objs.treemap.Outsidetextfont([color=], [colorsrc=], [family=], [familysrc=], [size=], [sizesrc=]) → Outsidetextfont

Create a new ‘Outsidetextfont’ object

  • 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`.

  • sizesrc - Sets the source reference on Chart Studio Cloud for `size`.

plotly.graph_objs.treemap.Pathbar([edgeshape=], [side=], [textfont=], [thickness=], [visible=]) → Pathbar

Create a new ‘Pathbar’ object

  • edgeshape - Determines which shape is used for edges between `barpath` labels.

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

  • textfont - Sets the font used inside `pathbar`.

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

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

plotly.graph_objs.treemap.Root([color=]) → Root

Create a new ‘Root’ object

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

plotly.graph_objs.treemap.Stream([maxpoints=], [token=]) → Stream

Create a new ‘Stream’ object

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

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

plotly.graph_objs.treemap.Textfont([color=], [colorsrc=], [family=], [familysrc=], [size=], [sizesrc=]) → Textfont

Create a new ‘Textfont’ object

  • 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`.

  • sizesrc - Sets the source reference on Chart Studio Cloud for `size`.

plotly.graph_objs.treemap.Tiling([flip=], [packing=], [pad=], [squarifyratio=]) → Tiling

Create a new ‘Tiling’ object

  • flip - Determines if the positions obtained from solver are flipped on each axis.

  • packing - Determines d3 treemap solver. For more info please refer to https://github.com/d3/d3-hierarchy#treemap-tiling

  • pad - Sets the inner padding (in px).

  • squarifyratio - When using *squarify* `packing` algorithm, according to https://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.

plotly.graph_objs.treemap.Transform() → Transform

Create a new ‘Transform’ object

Globals

Do you still have questions?

Our Community Forum is full of helpful information and Anvil experts.

plotly.graph_objs.table.legendgrouptitle plotly.graph_objs.treemap.hoverlabel

plotly.graph_objs.treemap