Treemap

Overview

The treemap trace type is used to create treemap charts, which visualize hierarchical data through nested rectangles. Each branch of the hierarchy is represented as a rectangle, with smaller rectangles inside representing sub-branches. Treemaps are useful for visualizing part-to-whole relationships and comparing the size of different categories.

You can customize the colors, labels, and hierarchy to represent your data effectively.

Common Uses

Hierarchical Data Visualization: Displaying nested data as a set of rectangles.
Part-to-Whole Relationships: Visualizing how different categories contribute to the whole.
Categorical Data: Showing categorical breakdowns with nested structures.

Check out the Attributes for the full set of configuration options

Unexpected Behavior

The terminal values of a treemap must be unique. In other words- if you create a treemap with multiple parent-child trees, the values must be unique across all squares that have no children.

Examples

Common Configurations

Simple Treemap PlotTreemap Plot with Custom ColorsTreemap Plot with Custom Tiling

Here's a simple treemap plot showing a hierarchy of categories:

You can copy this code below to create this chart in your project:

models:
  - name: treemap-data
    args:
      - echo
      - |
        labels,parents,values
        Total,,100
        A,Total,40
        B,Total,30
        C,Total,30
        D,A,10
        E,A,20
        F,B,10
traces:
  - name: Simple Treemap Plot
    model: ${ref(treemap-data)}
    props:
      type: treemap
      labels: ?{labels}
      parents: ?{parents}
      values: ?{"values"}
      marker: 
        colorscale: Blackbody
      textposition: "middle center"
      texttemplate: "<b>%{label}</b>"
      textfont:
        size: 12
charts:
  - name: Simple Treemap Chart
    traces:
      - ${ref(Simple Treemap Plot)}
    layout:
      title:
        text: Simple Treemap Chart<br><sub>Hierarchical Data Visualization</sub>

This example demonstrates a treemap plot where each category has custom colors:

Here's the code:

models:
  - name: treemap-data-colors
    args:
      - echo
      - |
        labels,parents,values,colors
        Total,,100,#1f77b4
        A,Total,40,#ff7f0e
        B,Total,30,#2ca02c
        C,Total,30,#d62728
        D,A,10,#9467bd
        E,A,20,#8c564b
        F,B,10,#e377c2
traces:
  - name: Treemap Plot with Custom Colors
    model: ${ref(treemap-data-colors)}
    props:
      type: treemap
      labels: ?{labels}
      parents: ?{parents}
      values: ?{"values"}
      marker:
        colors: ?{colors}
        line: 
          color: black
charts:
  - name: Treemap Chart with Custom Colors
    traces:
      - ${ref(Treemap Plot with Custom Colors)}
    layout:
      title:
        text: Treemap Plot with Custom Colors<br><sub>Custom Colors for Each Category</sub>

Here's a treemap plot where the tiling algorithm is customized:

Here's the code:

models:
  - name: treemap-data-tiling
    args:
      - echo
      - |
        labels,parents,values
        Total,,100
        A,Total,40
        B,Total,30
        C,Total,30
        D,A,15
        E,A,25
        F,B,10
        G,B,20
        H,C,15
        I,C,15
traces:
  - name: Treemap Plot with Custom Tiling
    model: ${ref(treemap-data-tiling)}
    props:
      type: treemap
      labels: ?{labels}
      parents: ?{parents}
      values: ?{"values"}
      tiling:
        packing: binary
        squarifyratio: 1.5
charts:
  - name: Treemap Chart with Custom Tiling
    traces:
      - ${ref(Treemap Plot with Custom Tiling)}
    layout:
      title:
        text: Treemap Plot with Custom Tiling<br><sub>Binary Packing and Custom Squarify Ratio</sub>

A schema to validate plotly trace properties

Attributes

These attributes apply to traces where trace.props.type is set to treemap. You would configure these attributes on the trace with the trace.props object.

branchvalues: 'any' 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: 'string' Determines default for values when it is not provided, by inferring a 1 for each of the leaves and/or branches, otherwise 0.

customdata: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for customdata.

domain:
  column: 'integer' If there is a layout grid, use the domain for this column in the grid for this treemap trace .

  row: 'integer' If there is a layout grid, use the domain for this row in the grid for this treemap trace .

  x: 'array' Sets the horizontal domain of this treemap trace (in plot fraction).

  y: 'array' Sets the vertical domain of this treemap trace (in plot fraction).

hoverinfo: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for hoverinfo.

hoverlabel:
  align: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for align.

  bgcolor: 'color | array' Sets the background color of the hover labels for this trace

  bgcolorsrc: 'string' Sets the source reference on Chart Studio Cloud for bgcolor.

  bordercolor: 'color | array' Sets the border color of the hover labels for this trace.

  bordercolorsrc: 'string' Sets the source reference on Chart Studio Cloud for bordercolor.

  font:
    color: color | array
    colorsrc: 'string' Sets the source reference on Chart Studio Cloud for color.

    family: 'string | array' HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

    familysrc: 'string' Sets the source reference on Chart Studio Cloud for family.

    lineposition: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for lineposition.

    shadow: 'string | array' 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: 'string' Sets the source reference on Chart Studio Cloud for shadow.

    size: number | array
    sizesrc: 'string' Sets the source reference on Chart Studio Cloud for size.

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

    stylesrc: 'string' Sets the source reference on Chart Studio Cloud for style.

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

    textcasesrc: 'string' Sets the source reference on Chart Studio Cloud for textcase.

    variant: 'array' Sets the variant of the font.

    variantsrc: 'string' Sets the source reference on Chart Studio Cloud for variant.

    weight: 'integer | array' Sets the weight (or boldness) of the font.

    weightsrc: 'string' Sets the source reference on Chart Studio Cloud for weight.

  namelength: 'integer | array' 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: 'string' Sets the source reference on Chart Studio Cloud for namelength.

hovertemplate: 'string | array' 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 "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.

hovertemplatesrc: 'string' Sets the source reference on Chart Studio Cloud for hovertemplate.

hovertext: 'string | array' 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: 'string' Sets the source reference on Chart Studio Cloud for hovertext.

ids: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for ids.

insidetextfont:
  color: color | array
  colorsrc: 'string' Sets the source reference on Chart Studio Cloud for color.

  family: 'string | array' HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

  familysrc: 'string' Sets the source reference on Chart Studio Cloud for family.

  lineposition: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for lineposition.

  shadow: 'string | array' 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: 'string' Sets the source reference on Chart Studio Cloud for shadow.

  size: number | array
  sizesrc: 'string' Sets the source reference on Chart Studio Cloud for size.

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

  stylesrc: 'string' Sets the source reference on Chart Studio Cloud for style.

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

  textcasesrc: 'string' Sets the source reference on Chart Studio Cloud for textcase.

  variant: 'array' Sets the variant of the font.

  variantsrc: 'string' Sets the source reference on Chart Studio Cloud for variant.

  weight: 'integer | array' Sets the weight (or boldness) of the font.

  weightsrc: 'string' Sets the source reference on Chart Studio Cloud for weight.

labels: 'array' Sets the labels of each of the sectors.

labelssrc: 'string' Sets the source reference on Chart Studio Cloud for labels.

legend: 'string' 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:
  font:
    color: any
    family: 'string' HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

    lineposition: 'string' 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: 'string' 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: number
    style: 'any' Sets whether a font should be styled with a normal or italic face from its family.

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

    variant: 'any' Sets the variant of the font.

    weight: 'integer' Sets the weight (or boldness) of the font.

  text: 'string' Sets the title of the legend group.

legendrank: 'number' 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: 'number' Sets the width (in px or fraction) of the legend for this trace.

marker:
  autocolorscale: 'boolean' 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: 'boolean' 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: 'number' 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: 'number' 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: 'number' 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: 'string' 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.

  colorbar:
    bgcolor: 'any' Sets the color of padded area.

    bordercolor: 'any' Sets the axis line color.

    borderwidth: 'number' Sets the width (in px) or the border enclosing this color bar.

    exponentformat: 'any' 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.

    len: 'number' 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: 'any' 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: 'number' Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is SI or B.

    nticks: 'integer' 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: 'any' Sets the orientation of the colorbar.

    outlinecolor: 'any' Sets the axis line color.

    outlinewidth: 'number' Sets the width (in px) of the axis line.

    separatethousands: 'boolean' If "true", even 4-digit integers are separated

    showexponent: 'any' 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: 'boolean' Determines whether or not the tick labels are drawn.

    showtickprefix: 'any' 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: 'any' Same as showtickprefix but for tick suffixes.

    thickness: 'number' Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

    thicknessmode: 'any' 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.

    tickangle: 'number' Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

    tickcolor: 'any' Sets the tick color.

    tickfont:
      color: any
      family: 'string' HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

      lineposition: 'string' 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: 'string' 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: number
      style: 'any' Sets whether a font should be styled with a normal or italic face from its family.

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

      variant: 'any' Sets the variant of the font.

      weight: 'integer' Sets the weight (or boldness) of the font.

    tickformat: 'string' Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: %h for half of the year as a decimal number as well as %{n}f for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat %H~%M~%S.%2f would display 09~15~23.46

    tickformatstops: array
    ticklabeloverflow: 'any' 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: 'any' 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: 'integer' 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: 'number' Sets the tick length (in px).

    tickmode: 'any' 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: 'string' Sets a tick label prefix.

    ticks: 'any' 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: 'string' Sets a tick label suffix.

    ticktext: 'array' Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with tickvals.

    ticktextsrc: 'string' Sets the source reference on Chart Studio Cloud for ticktext.

    tickvals: 'array' Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

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

    tickwidth: 'number' Sets the tick width (in px).

    title:
      font:
        color: any
        family: 'string' HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

        lineposition: 'string' 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: 'string' 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: number
        style: 'any' Sets whether a font should be styled with a normal or italic face from its family.

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

        variant: 'any' Sets the variant of the font.

        weight: 'integer' Sets the weight (or boldness) of the font.

      side: 'any' 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.

      text: 'string' Sets the title of the color bar.

    x: 'number' 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: 'any' 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: 'number' Sets the amount of padding (in px) along the x direction.

    xref: 'any' 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: 'number' 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: 'any' 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: 'number' Sets the amount of padding (in px) along the y direction.

    yref: 'any' Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

  colors: 'array' 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: 'any' 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: 'string' Sets the source reference on Chart Studio Cloud for colors.

  cornerradius: 'number' Sets the maximum rounding of corners (in px).

  depthfade: 'any' 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.

  line:
    color: 'color | array' Sets the color of the line enclosing each sector. Defaults to the paper_bgcolor value.

    colorsrc: 'string' Sets the source reference on Chart Studio Cloud for color.

    width: 'number | array' Sets the width (in px) of the line enclosing each sector.

    widthsrc: 'string' Sets the source reference on Chart Studio Cloud for width.

  pad:
    b: 'number' Sets the padding form the bottom (in px).

    l: 'number' Sets the padding form the left (in px).

    r: 'number' Sets the padding form the right (in px).

    t: 'number' Sets the padding form the top (in px).

  pattern:
    bgcolor: 'color | array' 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: 'string' Sets the source reference on Chart Studio Cloud for bgcolor.

    fgcolor: 'color | array' 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: 'string' Sets the source reference on Chart Studio Cloud for fgcolor.

    fgopacity: 'number' Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when fillmode is overlay. Otherwise, defaults to 1.

    fillmode: 'any' Determines whether marker.color should be used as a default to bgcolor or a fgcolor.

    shape: 'array' Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

    shapesrc: 'string' Sets the source reference on Chart Studio Cloud for shape.

    size: 'number | array' Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

    sizesrc: 'string' Sets the source reference on Chart Studio Cloud for size.

    solidity: 'number | array' 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: 'string' Sets the source reference on Chart Studio Cloud for solidity.

  reversescale: 'boolean' 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: 'boolean' Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.

maxdepth: 'integer' Sets the number of rendered sectors from any given level. Set maxdepth to -1 to render all the levels in the hierarchy.

metasrc: 'string' Sets the source reference on Chart Studio Cloud for meta.

name: 'string' Sets the trace name. The trace name appears as the legend item and on hover.

opacity: 'number' Sets the opacity of the trace.

outsidetextfont:
  color: color | array
  colorsrc: 'string' Sets the source reference on Chart Studio Cloud for color.

  family: 'string | array' HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

  familysrc: 'string' Sets the source reference on Chart Studio Cloud for family.

  lineposition: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for lineposition.

  shadow: 'string | array' 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: 'string' Sets the source reference on Chart Studio Cloud for shadow.

  size: number | array
  sizesrc: 'string' Sets the source reference on Chart Studio Cloud for size.

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

  stylesrc: 'string' Sets the source reference on Chart Studio Cloud for style.

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

  textcasesrc: 'string' Sets the source reference on Chart Studio Cloud for textcase.

  variant: 'array' Sets the variant of the font.

  variantsrc: 'string' Sets the source reference on Chart Studio Cloud for variant.

  weight: 'integer | array' Sets the weight (or boldness) of the font.

  weightsrc: 'string' Sets the source reference on Chart Studio Cloud for weight.

parents: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for parents.

pathbar:
  edgeshape: 'any' Determines which shape is used for edges between barpath labels.

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

  textfont:
    color: color | array
    colorsrc: 'string' Sets the source reference on Chart Studio Cloud for color.

    family: 'string | array' HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

    familysrc: 'string' Sets the source reference on Chart Studio Cloud for family.

    lineposition: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for lineposition.

    shadow: 'string | array' 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: 'string' Sets the source reference on Chart Studio Cloud for shadow.

    size: number | array
    sizesrc: 'string' Sets the source reference on Chart Studio Cloud for size.

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

    stylesrc: 'string' Sets the source reference on Chart Studio Cloud for style.

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

    textcasesrc: 'string' Sets the source reference on Chart Studio Cloud for textcase.

    variant: 'array' Sets the variant of the font.

    variantsrc: 'string' Sets the source reference on Chart Studio Cloud for variant.

    weight: 'integer | array' Sets the weight (or boldness) of the font.

    weightsrc: 'string' Sets the source reference on Chart Studio Cloud for weight.

  thickness: 'number' 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: 'boolean' Determines if the path bar is drawn i.e. outside the trace domain and with one pixel gap.

root:
  color: 'any' 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.

sort: 'boolean' Determines whether or not the sectors are reordered from largest to smallest.

stream:
  maxpoints: 'number' 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: 'string' The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

text: 'array' 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:
  color: color | array
  colorsrc: 'string' Sets the source reference on Chart Studio Cloud for color.

  family: 'string | array' HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.

  familysrc: 'string' Sets the source reference on Chart Studio Cloud for family.

  lineposition: 'array' 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: 'string' Sets the source reference on Chart Studio Cloud for lineposition.

  shadow: 'string | array' 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: 'string' Sets the source reference on Chart Studio Cloud for shadow.

  size: number | array
  sizesrc: 'string' Sets the source reference on Chart Studio Cloud for size.

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

  stylesrc: 'string' Sets the source reference on Chart Studio Cloud for style.

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

  textcasesrc: 'string' Sets the source reference on Chart Studio Cloud for textcase.

  variant: 'array' Sets the variant of the font.

  variantsrc: 'string' Sets the source reference on Chart Studio Cloud for variant.

  weight: 'integer | array' Sets the weight (or boldness) of the font.

  weightsrc: 'string' Sets the source reference on Chart Studio Cloud for weight.

textinfo: 'string' Determines which trace information appear on the graph.

textposition: 'any' Sets the positions of the text elements.

textsrc: 'string' Sets the source reference on Chart Studio Cloud for text.

texttemplate: 'string | array' 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: 'string' Sets the source reference on Chart Studio Cloud for texttemplate.

tiling:
  flip: 'string' Determines if the positions obtained from solver are flipped on each axis.

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

  pad: 'number' Sets the inner padding (in px).

  squarifyratio: 'number' 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.

type: treemap
uid: 'string' Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

values: 'array' Sets the values associated with each of the sectors. Use with branchvalues to determine how the values are summed.

valuessrc: 'string' Sets the source reference on Chart Studio Cloud for values.

visible: 'any' 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).