JavaScript Figure Reference: treemap Traces

A treemap trace is an object with the key "type" equal to "treemap" (i.e. {"type": "treemap"}) and any of the keys listed below.

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

  • type
    Parent: data[type=treemap]
    Type: "treemap"
  • name
    Parent: data[type=treemap]
    Type: string

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

  • visible
    Parent: data[type=treemap]
    Type: enumerated , one of ( true | false | "legendonly" )
    Default: true

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

  • legend
    Parent: data[type=treemap]
    Type: subplotid
    Default: 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.

  • legendrank
    Parent: data[type=treemap]
    Type: number
    Default: 1000

    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.

  • legendgrouptitle
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.
    • font
      Parent: data[type=treemap].legendgrouptitle
      Type: object containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Parent: data[type=treemap].legendgrouptitle.font
        Type: color
      • family
        Parent: data[type=treemap].legendgrouptitle.font
        Type: string

        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
        Parent: data[type=treemap].legendgrouptitle.font
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        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
        Parent: data[type=treemap].legendgrouptitle.font
        Type: string
        Default: "none"

        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
        Parent: data[type=treemap].legendgrouptitle.font
        Type: number greater than or equal to 1
      • style
        Parent: data[type=treemap].legendgrouptitle.font
        Type: enumerated , one of ( "normal" | "italic" )
        Default: "normal"

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

      • textcase
        Parent: data[type=treemap].legendgrouptitle.font
        Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

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

      • variant
        Parent: data[type=treemap].legendgrouptitle.font
        Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Parent: data[type=treemap].legendgrouptitle.font
        Type: integer between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • text
      Parent: data[type=treemap].legendgrouptitle
      Type: string
      Default: ""

      Sets the title of the legend group.

  • legendwidth
    Parent: data[type=treemap]
    Type: number greater than or equal to 0

    Sets the width (in px or fraction) of the legend for this trace.

  • opacity
    Parent: data[type=treemap]
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Parent: data[type=treemap]
    Type: data 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.

  • parents
    Parent: data[type=treemap]
    Type: data 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.

  • values
    Parent: data[type=treemap]
    Type: data array

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

  • labels
    Parent: data[type=treemap]
    Type: data array

    Sets the labels of each of the sectors.

  • text
    Parent: data[type=treemap]
    Type: data 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.

  • textposition
    Parent: data[type=treemap]
    Type: enumerated , one of ( "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right" )
    Default: "top left"

    Sets the positions of the `text` elements.

  • texttemplate
    Parent: data[type=treemap]
    Type: string or array of strings
    Default: ""

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

  • hovertext
    Parent: data[type=treemap]
    Type: string or array of strings
    Default: ""

    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.

  • hoverinfo
    Parent: data[type=treemap]
    Type: flaglist string. Any combination of "label", "text", "value", "name", "current path", "percent root", "percent entry", "percent parent" joined with a "+" OR "all" or "none" or "skip".
    Examples: "label", "text", "label+text", "label+text+value", "all"
    Default: "label+text+value+name"

    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.

  • hovertemplate
    Parent: data[type=treemap]
    Type: string or array of strings
    Default: ""

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

  • meta
    Parent: data[type=treemap]
    Type: number or categorical coordinate string

    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.

  • customdata
    Parent: data[type=treemap]
    Type: data 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

  • domain
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.
    • column
      Parent: data[type=treemap].domain
      Type: integer greater than or equal to 0
      Default: 0

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

    • row
      Parent: data[type=treemap].domain
      Type: integer greater than or equal to 0
      Default: 0

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

    • x
      Parent: data[type=treemap].domain
      Type: array
      Default: [0, 1]

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

    • y
      Parent: data[type=treemap].domain
      Type: array
      Default: [0, 1]

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

  • marker
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.
    • autocolorscale
      Parent: data[type=treemap].marker
      Type: boolean
      Default: true

      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
      Parent: data[type=treemap].marker
      Type: boolean
      Default: true

      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
      Parent: data[type=treemap].marker
      Type: 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
      Parent: data[type=treemap].marker
      Type: 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
      Parent: data[type=treemap].marker
      Type: 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
      Parent: data[type=treemap].marker
      Type: subplotid

      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
      Parent: data[type=treemap].marker
      Type: object containing one or more of the keys listed below.
      • bgcolor
        Parent: data[type=treemap].marker.colorbar
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • bordercolor
        Parent: data[type=treemap].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 0

        Sets the width (in px) or the border enclosing this color bar.

      • dtick
        Parent: data[type=treemap].marker.colorbar
        Type: number or categorical coordinate string

        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
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "none" | "e" | "E" | "power" | "SI" | "B" )
        Default: "B"

        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
        Parent: data[type=treemap].marker.colorbar
        Type: number or categorical coordinate string

        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
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        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
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "fraction"

        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
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 3

        Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".

      • nticks
        Parent: data[type=treemap].marker.colorbar
        Type: integer greater than or equal to 0
        Default: 0

        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
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "h" | "v" )
        Default: "v"

        Sets the orientation of the colorbar.

      • outlinecolor
        Parent: data[type=treemap].marker.colorbar
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the width (in px) of the axis line.

      • separatethousands
        Parent: data[type=treemap].marker.colorbar
        Type: boolean

        If "true", even 4-digit integers are separated

      • showexponent
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        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
        Parent: data[type=treemap].marker.colorbar
        Type: boolean
        Default: true

        Determines whether or not the tick labels are drawn.

      • showtickprefix
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        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
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • thickness
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 30

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

      • thicknessmode
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "fraction" | "pixels" )
        Default: "pixels"

        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
        Parent: data[type=treemap].marker.colorbar
        Type: number or categorical coordinate string

        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
        Parent: data[type=treemap].marker.colorbar
        Type: angle
        Default: "auto"

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

      • tickcolor
        Parent: data[type=treemap].marker.colorbar
        Type: color
        Default: "#444"

        Sets the tick color.

      • tickfont
        Parent: data[type=treemap].marker.colorbar
        Type: object containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • color
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: color
        • family
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: string

          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
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
          Examples: "under", "over", "under+over", "under+over+through", "none"
          Default: "none"

          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
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: string
          Default: "none"

          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
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: number greater than or equal to 1
        • style
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: enumerated , one of ( "normal" | "italic" )
          Default: "normal"

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

        • textcase
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
          Default: "normal"

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

        • variant
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
          Default: "normal"

          Sets the variant of the font.

        • weight
          Parent: data[type=treemap].marker.colorbar.tickfont
          Type: integer between or equal to 1 and 1000
          Default: normal

          Sets the weight (or boldness) of the font.

      • tickformat
        Parent: data[type=treemap].marker.colorbar
        Type: string
        Default: ""

        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
        Parent: data[type=treemap].marker.colorbar
        Type: array of object where each object has one or more of the keys listed below.
        • dtickrange
          Parent: data[type=treemap].marker.colorbar.tickformatstops[]
          Type: array

          range ["min", "max"], where "min", "max" - dtick values which describe some zoom level, it is possible to omit "min" or "max" value by passing "null"

        • enabled
          Parent: data[type=treemap].marker.colorbar.tickformatstops[]
          Type: boolean
          Default: true

          Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.

        • name
          Parent: data[type=treemap].marker.colorbar.tickformatstops[]
          Type: string

          When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.

        • templateitemname
          Parent: data[type=treemap].marker.colorbar.tickformatstops[]
          Type: string

          Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.

        • value
          Parent: data[type=treemap].marker.colorbar.tickformatstops[]
          Type: string
          Default: ""

          string - dtickformat for described zoom level, the same as "tickformat"

      • ticklabeloverflow
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "allow" | "hide past div" | "hide past domain" )

        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
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "outside top" | "inside top" | "outside left" | "inside left" | "outside right" | "inside right" | "outside bottom" | "inside bottom" )
        Default: "outside"

        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
        Parent: data[type=treemap].marker.colorbar
        Type: integer greater than or equal to 1
        Default: 1

        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
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickmode
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "auto" | "linear" | "array" )

        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
        Parent: data[type=treemap].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label prefix.

      • ticks
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "outside" | "inside" | "" )
        Default: ""

        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
        Parent: data[type=treemap].marker.colorbar
        Type: string
        Default: ""

        Sets a tick label suffix.

      • ticktext
        Parent: data[type=treemap].marker.colorbar
        Type: data array

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

      • tickvals
        Parent: data[type=treemap].marker.colorbar
        Type: data array

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

      • tickwidth
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • title
        Parent: data[type=treemap].marker.colorbar
        Type: object containing one or more of the keys listed below.
        • font
          Parent: data[type=treemap].marker.colorbar.title
          Type: object containing one or more of the keys listed below.

          Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.

          • color
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: color
          • family
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: string

            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
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
            Examples: "under", "over", "under+over", "under+over+through", "none"
            Default: "none"

            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
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: string
            Default: "none"

            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
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: number greater than or equal to 1
          • style
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: enumerated , one of ( "normal" | "italic" )
            Default: "normal"

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

          • textcase
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: enumerated , one of ( "normal" | "word caps" | "upper" | "lower" )
            Default: "normal"

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

          • variant
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: enumerated , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
            Default: "normal"

            Sets the variant of the font.

          • weight
            Parent: data[type=treemap].marker.colorbar.title.font
            Type: integer between or equal to 1 and 1000
            Default: normal

            Sets the weight (or boldness) of the font.

        • side
          Parent: data[type=treemap].marker.colorbar.title
          Type: enumerated , one of ( "right" | "top" | "bottom" )

          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.

        • text
          Parent: data[type=treemap].marker.colorbar.title
          Type: string

          Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.

      • x
        Parent: data[type=treemap].marker.colorbar
        Type: 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
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "left" | "center" | "right" )

        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
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

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

      • xref
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "container" | "paper" )
        Default: "paper"

        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
        Parent: data[type=treemap].marker.colorbar
        Type: 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
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "top" | "middle" | "bottom" )

        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
        Parent: data[type=treemap].marker.colorbar
        Type: number greater than or equal to 0
        Default: 10

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

      • yref
        Parent: data[type=treemap].marker.colorbar
        Type: enumerated , one of ( "container" | "paper" )
        Default: "paper"

        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
      Parent: data[type=treemap].marker
      Type: data 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
      Parent: data[type=treemap].marker
      Type: 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.

    • cornerradius
      Parent: data[type=treemap].marker
      Type: number greater than or equal to 0
      Default: 0

      Sets the maximum rounding of corners (in px).

    • depthfade
      Parent: data[type=treemap].marker
      Type: enumerated , one of ( true | false | "reversed" )

      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
      Parent: data[type=treemap].marker
      Type: object containing one or more of the keys listed below.
      • color
        Parent: data[type=treemap].marker.line
        Type: color or array of colors

        Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.

      • width
        Parent: data[type=treemap].marker.line
        Type: number or array of numbers greater than or equal to 0
        Default: 1

        Sets the width (in px) of the line enclosing each sector.

    • pad
      Parent: data[type=treemap].marker
      Type: object containing one or more of the keys listed below.
      • b
        Parent: data[type=treemap].marker.pad
        Type: number greater than or equal to 0

        Sets the padding form the bottom (in px).

      • l
        Parent: data[type=treemap].marker.pad
        Type: number greater than or equal to 0

        Sets the padding form the left (in px).

      • r
        Parent: data[type=treemap].marker.pad
        Type: number greater than or equal to 0

        Sets the padding form the right (in px).

      • t
        Parent: data[type=treemap].marker.pad
        Type: number greater than or equal to 0

        Sets the padding form the top (in px).

    • pattern
      Parent: data[type=treemap].marker
      Type: object containing one or more of the keys listed below.

      Sets the pattern within the marker.

      • bgcolor
        Parent: data[type=treemap].marker.pattern
        Type: color or array of colors

        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.

      • fgcolor
        Parent: data[type=treemap].marker.pattern
        Type: color or array of colors

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

      • fgopacity
        Parent: data[type=treemap].marker.pattern
        Type: number between or equal to 0 and 1

        Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.

      • fillmode
        Parent: data[type=treemap].marker.pattern
        Type: enumerated , one of ( "replace" | "overlay" )
        Default: "replace"

        Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.

      • shape
        Parent: data[type=treemap].marker.pattern
        Type: enumerated or array of enumerateds , one of ( "" | "/" | "\" | "x" | "-" | "|" | "+" | "." )
        Default: ""

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

      • size
        Parent: data[type=treemap].marker.pattern
        Type: number or array of numbers greater than or equal to 0
        Default: 8

        Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

      • solidity
        Parent: data[type=treemap].marker.pattern
        Type: number or array of numbers between or equal to 0 and 1
        Default: 0.3

        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.

    • reversescale
      Parent: data[type=treemap].marker
      Type: 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
      Parent: data[type=treemap].marker
      Type: boolean

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

  • textfont
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.

    Sets the font used for `textinfo`.

    • color
      Parent: data[type=treemap].textfont
      Type: color or array of colors
    • family
      Parent: data[type=treemap].textfont
      Type: string or array of strings

      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
      Parent: data[type=treemap].textfont
      Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
      Examples: "under", "over", "under+over", "under+over+through", "none"
      Default: "none"

      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
      Parent: data[type=treemap].textfont
      Type: string or array of strings
      Default: "none"

      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
      Parent: data[type=treemap].textfont
      Type: number or array of numbers greater than or equal to 1
    • style
      Parent: data[type=treemap].textfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "italic" )
      Default: "normal"

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

    • textcase
      Parent: data[type=treemap].textfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "word caps" | "upper" | "lower" )
      Default: "normal"

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

    • variant
      Parent: data[type=treemap].textfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
      Default: "normal"

      Sets the variant of the font.

    • weight
      Parent: data[type=treemap].textfont
      Type: integer or array of integers between or equal to 1 and 1000
      Default: normal

      Sets the weight (or boldness) of the font.

  • textinfo
    Parent: data[type=treemap]
    Type: flaglist string. Any combination of "label", "text", "value", "current path", "percent root", "percent entry", "percent parent" joined with a "+" OR "none".
    Examples: "label", "text", "label+text", "label+text+value", "none"

    Determines which trace information appear on the graph.

  • branchvalues
    Parent: data[type=treemap]
    Type: enumerated , one of ( "remainder" | "total" )
    Default: "remainder"

    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
    Parent: data[type=treemap]
    Type: flaglist string. Any combination of "branches", "leaves" joined with a "+"
    Examples: "branches", "leaves", "branches+leaves"
    Default: "leaves"

    Determines default for `values` when it is not provided, by inferring a 1 for each of the "leaves" and/or "branches", otherwise 0.

  • tiling
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.
    • flip
      Parent: data[type=treemap].tiling
      Type: flaglist string. Any combination of "x", "y" joined with a "+"
      Examples: "x", "y", "x+y"
      Default: ""

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

    • packing
      Parent: data[type=treemap].tiling
      Type: enumerated , one of ( "squarify" | "binary" | "dice" | "slice" | "slice-dice" | "dice-slice" )
      Default: "squarify"

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

    • pad
      Parent: data[type=treemap].tiling
      Type: number greater than or equal to 0
      Default: 3

      Sets the inner padding (in px).

    • squarifyratio
      Parent: data[type=treemap].tiling
      Type: number greater than or equal to 1
      Default: 1

      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.

  • pathbar
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.
    • edgeshape
      Parent: data[type=treemap].pathbar
      Type: enumerated , one of ( ">" | "<" | "|" | "/" | "\" )
      Default: ">"

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

    • side
      Parent: data[type=treemap].pathbar
      Type: enumerated , one of ( "top" | "bottom" )
      Default: "top"

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

    • textfont
      Parent: data[type=treemap].pathbar
      Type: object containing one or more of the keys listed below.

      Sets the font used inside `pathbar`.

      • color
        Parent: data[type=treemap].pathbar.textfont
        Type: color or array of colors
      • family
        Parent: data[type=treemap].pathbar.textfont
        Type: string or array of strings

        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
        Parent: data[type=treemap].pathbar.textfont
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        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
        Parent: data[type=treemap].pathbar.textfont
        Type: string or array of strings
        Default: "none"

        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
        Parent: data[type=treemap].pathbar.textfont
        Type: number or array of numbers greater than or equal to 1
      • style
        Parent: data[type=treemap].pathbar.textfont
        Type: enumerated or array of enumerateds , one of ( "normal" | "italic" )
        Default: "normal"

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

      • textcase
        Parent: data[type=treemap].pathbar.textfont
        Type: enumerated or array of enumerateds , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

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

      • variant
        Parent: data[type=treemap].pathbar.textfont
        Type: enumerated or array of enumerateds , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Parent: data[type=treemap].pathbar.textfont
        Type: integer or array of integers between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • thickness
      Parent: data[type=treemap].pathbar
      Type: number greater than or equal to 12

      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
      Parent: data[type=treemap].pathbar
      Type: boolean
      Default: true

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

  • hoverlabel
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.
    • align
      Parent: data[type=treemap].hoverlabel
      Type: enumerated or array of enumerateds , one of ( "left" | "right" | "auto" )
      Default: "auto"

      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

    • bgcolor
      Parent: data[type=treemap].hoverlabel
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

    • bordercolor
      Parent: data[type=treemap].hoverlabel
      Type: color or array of colors

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

    • font
      Parent: data[type=treemap].hoverlabel
      Type: object containing one or more of the keys listed below.

      Sets the font used in hover labels.

      • color
        Parent: data[type=treemap].hoverlabel.font
        Type: color or array of colors
      • family
        Parent: data[type=treemap].hoverlabel.font
        Type: string or array of strings

        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
        Parent: data[type=treemap].hoverlabel.font
        Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
        Examples: "under", "over", "under+over", "under+over+through", "none"
        Default: "none"

        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
        Parent: data[type=treemap].hoverlabel.font
        Type: string or array of strings
        Default: "none"

        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
        Parent: data[type=treemap].hoverlabel.font
        Type: number or array of numbers greater than or equal to 1
      • style
        Parent: data[type=treemap].hoverlabel.font
        Type: enumerated or array of enumerateds , one of ( "normal" | "italic" )
        Default: "normal"

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

      • textcase
        Parent: data[type=treemap].hoverlabel.font
        Type: enumerated or array of enumerateds , one of ( "normal" | "word caps" | "upper" | "lower" )
        Default: "normal"

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

      • variant
        Parent: data[type=treemap].hoverlabel.font
        Type: enumerated or array of enumerateds , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
        Default: "normal"

        Sets the variant of the font.

      • weight
        Parent: data[type=treemap].hoverlabel.font
        Type: integer or array of integers between or equal to 1 and 1000
        Default: normal

        Sets the weight (or boldness) of the font.

    • namelength
      Parent: data[type=treemap].hoverlabel
      Type: integer or array of integers greater than or equal to -1
      Default: 15

      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.

  • insidetextfont
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.

    Sets the font used for `textinfo` lying inside the sector.

    • color
      Parent: data[type=treemap].insidetextfont
      Type: color or array of colors
    • family
      Parent: data[type=treemap].insidetextfont
      Type: string or array of strings

      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
      Parent: data[type=treemap].insidetextfont
      Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
      Examples: "under", "over", "under+over", "under+over+through", "none"
      Default: "none"

      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
      Parent: data[type=treemap].insidetextfont
      Type: string or array of strings
      Default: "none"

      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
      Parent: data[type=treemap].insidetextfont
      Type: number or array of numbers greater than or equal to 1
    • style
      Parent: data[type=treemap].insidetextfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "italic" )
      Default: "normal"

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

    • textcase
      Parent: data[type=treemap].insidetextfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "word caps" | "upper" | "lower" )
      Default: "normal"

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

    • variant
      Parent: data[type=treemap].insidetextfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
      Default: "normal"

      Sets the variant of the font.

    • weight
      Parent: data[type=treemap].insidetextfont
      Type: integer or array of integers between or equal to 1 and 1000
      Default: normal

      Sets the weight (or boldness) of the font.

  • outsidetextfont
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.

    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.

    • color
      Parent: data[type=treemap].outsidetextfont
      Type: color or array of colors
    • family
      Parent: data[type=treemap].outsidetextfont
      Type: string or array of strings

      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
      Parent: data[type=treemap].outsidetextfont
      Type: flaglist string. Any combination of "under", "over", "through" joined with a "+" OR "none".
      Examples: "under", "over", "under+over", "under+over+through", "none"
      Default: "none"

      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
      Parent: data[type=treemap].outsidetextfont
      Type: string or array of strings
      Default: "none"

      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
      Parent: data[type=treemap].outsidetextfont
      Type: number or array of numbers greater than or equal to 1
    • style
      Parent: data[type=treemap].outsidetextfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "italic" )
      Default: "normal"

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

    • textcase
      Parent: data[type=treemap].outsidetextfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "word caps" | "upper" | "lower" )
      Default: "normal"

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

    • variant
      Parent: data[type=treemap].outsidetextfont
      Type: enumerated or array of enumerateds , one of ( "normal" | "small-caps" | "all-small-caps" | "all-petite-caps" | "petite-caps" | "unicase" )
      Default: "normal"

      Sets the variant of the font.

    • weight
      Parent: data[type=treemap].outsidetextfont
      Type: integer or array of integers between or equal to 1 and 1000
      Default: normal

      Sets the weight (or boldness) of the font.

  • root
    Parent: data[type=treemap]
    Type: object containing one or more of the keys listed below.
    • color
      Parent: data[type=treemap].root
      Type: color
      Default: "rgba(0,0,0,0)"

      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.

  • level
    Parent: data[type=treemap]
    Type: number or categorical coordinate string

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

  • maxdepth
    Parent: data[type=treemap]
    Type: integer
    Default: -1

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

  • sort
    Parent: data[type=treemap]
    Type: boolean
    Default: true

    Determines whether or not the sectors are reordered from largest to smallest.

  • uirevision
    Parent: data[type=treemap]
    Type: number or categorical coordinate string

    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.