Python Figure Reference: icicle Traces

A plotly.graph_objects.Icicle trace is a graph object in the figure's data list with any of the named arguments or attributes listed below.

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

  • name
    Code: fig.update_traces(name=<VALUE>, selector=dict(type='icicle'))
    Type: string

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

  • visible
    Code: fig.update_traces(visible=<VALUE>, selector=dict(type='icicle'))
    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).

  • legendrank
    Code: fig.update_traces(legendrank=<VALUE>, selector=dict(type='icicle'))
    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.

  • legendgrouptitle
    Code: fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.
    • font
      Code: fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='icicle'))
      Type: dict containing one or more of the keys listed below.

      Sets this legend group's title font.

      • color
        Code: fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='icicle'))
        Type: color
      • family
        Code: fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='icicle'))
        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".

      • size
        Code: fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='icicle'))
        Type: number greater than or equal to 1
    • text
      Code: fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='icicle'))
      Type: string
      Default: ""

      Sets the title of the legend group.

  • opacity
    Code: fig.update_traces(opacity=<VALUE>, selector=dict(type='icicle'))
    Type: number between or equal to 0 and 1
    Default: 1

    Sets the opacity of the trace.

  • ids
    Code: fig.update_traces(ids=<VALUE>, selector=dict(type='icicle'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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
    Code: fig.update_traces(parents=<VALUE>, selector=dict(type='icicle'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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
    Code: fig.update_traces(values=<VALUE>, selector=dict(type='icicle'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

  • labels
    Code: fig.update_traces(labels=<VALUE>, selector=dict(type='icicle'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    Sets the labels of each of the sectors.

  • text
    Code: fig.update_traces(text=<VALUE>, selector=dict(type='icicle'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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
    Code: fig.update_traces(textposition=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(texttemplate=<VALUE>, selector=dict(type='icicle'))
    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. variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`.

  • hovertext
    Code: fig.update_traces(hovertext=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='icicle'))
    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. 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
    Code: fig.update_traces(meta=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(customdata=<VALUE>, selector=dict(type='icicle'))
    Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

    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
    Code: fig.update_traces(domain=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.
    • column
      Code: fig.update_traces(domain_column=<VALUE>, selector=dict(type='icicle'))
      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 icicle trace .

    • row
      Code: fig.update_traces(domain_row=<VALUE>, selector=dict(type='icicle'))
      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 icicle trace .

    • x
      Code: fig.update_traces(domain_x=list(...), selector=dict(type='icicle'))
      Type: list
      Default: [0, 1]

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

    • y
      Code: fig.update_traces(domain_y=list(...), selector=dict(type='icicle'))
      Type: list
      Default: [0, 1]

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

  • marker
    Code: fig.update_traces(marker=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.
    • autocolorscale
      Code: fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='icicle'))
      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 colorsis 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
      Code: fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='icicle'))
      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 colorsis set to a numerical array. Defaults to `False` when `marker.cmin` and `marker.cmax` are set by the user.

    • cmax
      Code: fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='icicle'))
      Type: number

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

    • cmid
      Code: fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='icicle'))
      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 colorsis set to a numerical array. Value should have the same units as colors. Has no effect when `marker.cauto` is `False`.

    • cmin
      Code: fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='icicle'))
      Type: number

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

    • coloraxis
      Code: fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='icicle'))
      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
      Code: fig.update_traces(marker_colorbar=dict(...), selector=dict(type='icicle'))
      Type: dict containing one or more of the keys listed below.
      • bgcolor
        Code: fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='icicle'))
        Type: color
        Default: "rgba(0,0,0,0)"

        Sets the color of padded area.

      • bordercolor
        Code: fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='icicle'))
        Type: color
        Default: "#444"

        Sets the axis line color.

      • borderwidth
        Code: fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='icicle'))
        Type: number greater than or equal to 0
        Default: 0

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

      • dtick
        Code: fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='icicle'))
        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.

      • len
        Code: fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='icicle'))
        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".

      • outlinecolor
        Code: fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='icicle'))
        Type: color
        Default: "#444"

        Sets the axis line color.

      • outlinewidth
        Code: fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='icicle'))
        Type: number greater than or equal to 0
        Default: 1

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

      • separatethousands
        Code: fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='icicle'))
        Type: boolean

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

      • showexponent
        Code: fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='icicle'))
        Type: boolean
        Default: True

        Determines whether or not the tick labels are drawn.

      • showtickprefix
        Code: fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='icicle'))
        Type: enumerated , one of ( "all" | "first" | "last" | "none" )
        Default: "all"

        Same as `showtickprefix` but for tick suffixes.

      • thickness
        Code: fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='icicle'))
        Type: color
        Default: "#444"

        Sets the tick color.

      • tickfont
        Code: fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='icicle'))
        Type: dict containing one or more of the keys listed below.

        Sets the color bar's tick label font

        • color
          Code: fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='icicle'))
          Type: color
        • family
          Code: fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='icicle'))
          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".

        • size
          Code: fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='icicle'))
          Type: number greater than or equal to 1
      • tickformat
        Code: fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='icicle'))
        Type: list of dict where each dict has one or more of the keys listed below.
        • dtickrange
          Parent: data[type=icicle].marker.colorbar.tickformatstops[]
          Type: list

          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=icicle].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=icicle].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=icicle].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=icicle].marker.colorbar.tickformatstops[]
          Type: string
          Default: ""

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

      • ticklabeloverflow
        Code: fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='icicle'))
        Type: enumerated , one of ( "outside" | "inside" | "outside top" | "inside top" | "outside bottom" | "inside bottom" )
        Default: "outside"

        Determines where tick labels are drawn.

      • ticklen
        Code: fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='icicle'))
        Type: number greater than or equal to 0
        Default: 5

        Sets the tick length (in px).

      • tickmode
        Code: fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='icicle'))
        Type: string
        Default: ""

        Sets a tick label prefix.

      • ticks
        Code: fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='icicle'))
        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
        Code: fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='icicle'))
        Type: string
        Default: ""

        Sets a tick label suffix.

      • ticktext
        Code: fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='icicle'))
        Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

      • tickvals
        Code: fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='icicle'))
        Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

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

      • tickwidth
        Code: fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='icicle'))
        Type: number greater than or equal to 0
        Default: 1

        Sets the tick width (in px).

      • title
        Code: fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='icicle'))
        Type: dict containing one or more of the keys listed below.
        • font
          Code: fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='icicle'))
          Type: dict 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
            Code: fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='icicle'))
            Type: color
          • family
            Code: fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='icicle'))
            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".

          • size
            Code: fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='icicle'))
            Type: number greater than or equal to 1
        • side
          Code: fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='icicle'))
          Type: enumerated , one of ( "right" | "top" | "bottom" )
          Default: "top"

          Determines the location of color bar's title with respect to the color bar. Note that the title's location used to be set by the now deprecated `titleside` attribute.

        • text
          Code: fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='icicle'))
          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
        Code: fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='icicle'))
        Type: number between or equal to -2 and 3
        Default: 1.02

        Sets the x position of the color bar (in plot fraction).

      • xanchor
        Code: fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='icicle'))
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.

      • xpad
        Code: fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='icicle'))
        Type: number greater than or equal to 0
        Default: 10

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

      • y
        Code: fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='icicle'))
        Type: number between or equal to -2 and 3
        Default: 0.5

        Sets the y position of the color bar (in plot fraction).

      • yanchor
        Code: fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='icicle'))
        Type: enumerated , one of ( "top" | "middle" | "bottom" )
        Default: "middle"

        Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.

      • ypad
        Code: fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='icicle'))
        Type: number greater than or equal to 0
        Default: 10

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

    • colors
      Code: fig.update_traces(marker_colors=<VALUE>, selector=dict(type='icicle'))
      Type: list, numpy array, or Pandas series of numbers, strings, or datetimes.

      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
      Code: fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='icicle'))
      Type: colorscale

      Sets the colorscale. Has an effect only if colorsis 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.

    • line
      Code: fig.update_traces(marker_line=dict(...), selector=dict(type='icicle'))
      Type: dict containing one or more of the keys listed below.
      • color
        Code: fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='icicle'))
        Type: color or array of colors

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

      • width
        Code: fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='icicle'))
        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.

    • reversescale
      Code: fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='icicle'))
      Type: boolean

      Reverses the color mapping if True. Has an effect only if colorsis 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
      Code: fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='icicle'))
      Type: boolean

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

  • textfont
    Code: fig.update_traces(textfont=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.

    Sets the font used for `textinfo`.

    • color
      Code: fig.update_traces(textfont_color=<VALUE>, selector=dict(type='icicle'))
      Type: color or array of colors
    • family
      Code: fig.update_traces(textfont_family=<VALUE>, selector=dict(type='icicle'))
      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".

    • size
      Code: fig.update_traces(textfont_size=<VALUE>, selector=dict(type='icicle'))
      Type: number or array of numbers greater than or equal to 1
  • textinfo
    Code: fig.update_traces(textinfo=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(branchvalues=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(count=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(tiling=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.
    • flip
      Code: fig.update_traces(tiling_flip=<VALUE>, selector=dict(type='icicle'))
      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.

    • orientation
      Code: fig.update_traces(tiling_orientation=<VALUE>, selector=dict(type='icicle'))
      Type: enumerated , one of ( "v" | "h" )
      Default: "h"

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

    • pad
      Code: fig.update_traces(tiling_pad=<VALUE>, selector=dict(type='icicle'))
      Type: number greater than or equal to 0
      Default: 0

      Sets the inner padding (in px).

  • pathbar
    Code: fig.update_traces(pathbar=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.
    • edgeshape
      Code: fig.update_traces(pathbar_edgeshape=<VALUE>, selector=dict(type='icicle'))
      Type: enumerated , one of ( ">" | "<" | "|" | "/" | "\" )
      Default: ">"

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

    • side
      Code: fig.update_traces(pathbar_side=<VALUE>, selector=dict(type='icicle'))
      Type: enumerated , one of ( "top" | "bottom" )
      Default: "top"

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

    • textfont
      Code: fig.update_traces(pathbar_textfont=dict(...), selector=dict(type='icicle'))
      Type: dict containing one or more of the keys listed below.

      Sets the font used inside `pathbar`.

      • color
        Code: fig.update_traces(pathbar_textfont_color=<VALUE>, selector=dict(type='icicle'))
        Type: color or array of colors
      • family
        Code: fig.update_traces(pathbar_textfont_family=<VALUE>, selector=dict(type='icicle'))
        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".

      • size
        Code: fig.update_traces(pathbar_textfont_size=<VALUE>, selector=dict(type='icicle'))
        Type: number or array of numbers greater than or equal to 1
    • thickness
      Code: fig.update_traces(pathbar_thickness=<VALUE>, selector=dict(type='icicle'))
      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
      Code: fig.update_traces(pathbar_visible=<VALUE>, selector=dict(type='icicle'))
      Type: boolean
      Default: True

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

  • hoverlabel
    Code: fig.update_traces(hoverlabel=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.
    • align
      Code: fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='icicle'))
      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
      Code: fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='icicle'))
      Type: color or array of colors

      Sets the background color of the hover labels for this trace

    • bordercolor
      Code: fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='icicle'))
      Type: color or array of colors

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

    • font
      Code: fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='icicle'))
      Type: dict containing one or more of the keys listed below.

      Sets the font used in hover labels.

      • color
        Code: fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='icicle'))
        Type: color or array of colors
      • family
        Code: fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='icicle'))
        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".

      • size
        Code: fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='icicle'))
        Type: number or array of numbers greater than or equal to 1
    • namelength
      Code: fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='icicle'))
      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
    Code: fig.update_traces(insidetextfont=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.

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

    • color
      Code: fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='icicle'))
      Type: color or array of colors
    • family
      Code: fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='icicle'))
      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".

    • size
      Code: fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='icicle'))
      Type: number or array of numbers greater than or equal to 1
  • outsidetextfont
    Code: fig.update_traces(outsidetextfont=dict(...), selector=dict(type='icicle'))
    Type: dict 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
      Code: fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='icicle'))
      Type: color or array of colors
    • family
      Code: fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='icicle'))
      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".

    • size
      Code: fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='icicle'))
      Type: number or array of numbers greater than or equal to 1
  • root
    Code: fig.update_traces(root=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.
    • color
      Code: fig.update_traces(root_color=<VALUE>, selector=dict(type='icicle'))
      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.

  • leaf
    Code: fig.update_traces(leaf=dict(...), selector=dict(type='icicle'))
    Type: dict containing one or more of the keys listed below.
    • opacity
      Code: fig.update_traces(leaf_opacity=<VALUE>, selector=dict(type='icicle'))
      Type: number between or equal to 0 and 1

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

  • level
    Code: fig.update_traces(level=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(maxdepth=<VALUE>, selector=dict(type='icicle'))
    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
    Code: fig.update_traces(sort=<VALUE>, selector=dict(type='icicle'))
    Type: boolean
    Default: True

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

  • uirevision
    Code: fig.update_traces(uirevision=<VALUE>, selector=dict(type='icicle'))
    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.